Oracle Cloud Infrastructure v3.9.0 published on Wednesday, Sep 24, 2025 by Pulumi
oci.Bastion.getBastions
This data source provides the list of Bastions in Oracle Cloud Infrastructure Bastion service.
Retrieves a list of BastionSummary objects in a compartment. Bastions provide secured, public access to target resources in the cloud that you cannot otherwise reach from the internet.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testBastions = oci.Bastion.getBastions({
compartmentId: compartmentId,
bastionId: testBastion.id,
bastionLifecycleState: bastionBastionLifecycleState,
name: bastionName,
});
import pulumi
import pulumi_oci as oci
test_bastions = oci.Bastion.get_bastions(compartment_id=compartment_id,
bastion_id=test_bastion["id"],
bastion_lifecycle_state=bastion_bastion_lifecycle_state,
name=bastion_name)
package main
import (
"github.com/pulumi/pulumi-oci/sdk/v3/go/oci/bastion"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := bastion.GetBastions(ctx, &bastion.GetBastionsArgs{
CompartmentId: compartmentId,
BastionId: pulumi.StringRef(testBastion.Id),
BastionLifecycleState: pulumi.StringRef(bastionBastionLifecycleState),
Name: pulumi.StringRef(bastionName),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testBastions = Oci.Bastion.GetBastions.Invoke(new()
{
CompartmentId = compartmentId,
BastionId = testBastion.Id,
BastionLifecycleState = bastionBastionLifecycleState,
Name = bastionName,
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Bastion.BastionFunctions;
import com.pulumi.oci.Bastion.inputs.GetBastionsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var testBastions = BastionFunctions.getBastions(GetBastionsArgs.builder()
.compartmentId(compartmentId)
.bastionId(testBastion.id())
.bastionLifecycleState(bastionBastionLifecycleState)
.name(bastionName)
.build());
}
}
variables:
testBastions:
fn::invoke:
function: oci:Bastion:getBastions
arguments:
compartmentId: ${compartmentId}
bastionId: ${testBastion.id}
bastionLifecycleState: ${bastionBastionLifecycleState}
name: ${bastionName}
Using getBastions
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getBastions(args: GetBastionsArgs, opts?: InvokeOptions): Promise<GetBastionsResult>
function getBastionsOutput(args: GetBastionsOutputArgs, opts?: InvokeOptions): Output<GetBastionsResult>
def get_bastions(bastion_id: Optional[str] = None,
bastion_lifecycle_state: Optional[str] = None,
compartment_id: Optional[str] = None,
filters: Optional[Sequence[GetBastionsFilter]] = None,
name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetBastionsResult
def get_bastions_output(bastion_id: Optional[pulumi.Input[str]] = None,
bastion_lifecycle_state: Optional[pulumi.Input[str]] = None,
compartment_id: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetBastionsFilterArgs]]]] = None,
name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetBastionsResult]
func GetBastions(ctx *Context, args *GetBastionsArgs, opts ...InvokeOption) (*GetBastionsResult, error)
func GetBastionsOutput(ctx *Context, args *GetBastionsOutputArgs, opts ...InvokeOption) GetBastionsResultOutput
> Note: This function is named GetBastions
in the Go SDK.
public static class GetBastions
{
public static Task<GetBastionsResult> InvokeAsync(GetBastionsArgs args, InvokeOptions? opts = null)
public static Output<GetBastionsResult> Invoke(GetBastionsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetBastionsResult> getBastions(GetBastionsArgs args, InvokeOptions options)
public static Output<GetBastionsResult> getBastions(GetBastionsArgs args, InvokeOptions options)
fn::invoke:
function: oci:Bastion/getBastions:getBastions
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id string - The unique identifier (OCID) of the compartment in which to list resources.
- Bastion
Id string - The unique identifier (OCID) of the bastion in which to list resources.
- Bastion
Lifecycle stringState - A filter to return only resources their lifecycleState matches the given lifecycleState.
- Filters
List<Get
Bastions Filter> - Name string
- A filter to return only resources that match the entire name given.
- Compartment
Id string - The unique identifier (OCID) of the compartment in which to list resources.
- Bastion
Id string - The unique identifier (OCID) of the bastion in which to list resources.
- Bastion
Lifecycle stringState - A filter to return only resources their lifecycleState matches the given lifecycleState.
- Filters
[]Get
Bastions Filter - Name string
- A filter to return only resources that match the entire name given.
- compartment
Id String - The unique identifier (OCID) of the compartment in which to list resources.
- bastion
Id String - The unique identifier (OCID) of the bastion in which to list resources.
- bastion
Lifecycle StringState - A filter to return only resources their lifecycleState matches the given lifecycleState.
- filters
List<Gets
Filter> - name String
- A filter to return only resources that match the entire name given.
- compartment
Id string - The unique identifier (OCID) of the compartment in which to list resources.
- bastion
Id string - The unique identifier (OCID) of the bastion in which to list resources.
- bastion
Lifecycle stringState - A filter to return only resources their lifecycleState matches the given lifecycleState.
- filters
Get
Bastions Filter[] - name string
- A filter to return only resources that match the entire name given.
- compartment_
id str - The unique identifier (OCID) of the compartment in which to list resources.
- bastion_
id str - The unique identifier (OCID) of the bastion in which to list resources.
- bastion_
lifecycle_ strstate - A filter to return only resources their lifecycleState matches the given lifecycleState.
- filters
Sequence[Get
Bastions Filter] - name str
- A filter to return only resources that match the entire name given.
- compartment
Id String - The unique identifier (OCID) of the compartment in which to list resources.
- bastion
Id String - The unique identifier (OCID) of the bastion in which to list resources.
- bastion
Lifecycle StringState - A filter to return only resources their lifecycleState matches the given lifecycleState.
- filters List<Property Map>
- name String
- A filter to return only resources that match the entire name given.
getBastions Result
The following output properties are available:
- Bastions
List<Get
Bastions Bastion> - The list of bastions.
- Compartment
Id string - The unique identifier (OCID) of the compartment where the bastion is located.
- Id string
- The provider-assigned unique ID for this managed resource.
- Bastion
Id string - Bastion
Lifecycle stringState - Filters
List<Get
Bastions Filter> - Name string
- The name of the bastion, which can't be changed after creation.
- Bastions
[]Get
Bastions Bastion - The list of bastions.
- Compartment
Id string - The unique identifier (OCID) of the compartment where the bastion is located.
- Id string
- The provider-assigned unique ID for this managed resource.
- Bastion
Id string - Bastion
Lifecycle stringState - Filters
[]Get
Bastions Filter - Name string
- The name of the bastion, which can't be changed after creation.
- bastions List<Gets>
- The list of bastions.
- compartment
Id String - The unique identifier (OCID) of the compartment where the bastion is located.
- id String
- The provider-assigned unique ID for this managed resource.
- bastion
Id String - bastion
Lifecycle StringState - filters
List<Gets
Filter> - name String
- The name of the bastion, which can't be changed after creation.
- bastions
Get
Bastions Bastion[] - The list of bastions.
- compartment
Id string - The unique identifier (OCID) of the compartment where the bastion is located.
- id string
- The provider-assigned unique ID for this managed resource.
- bastion
Id string - bastion
Lifecycle stringState - filters
Get
Bastions Filter[] - name string
- The name of the bastion, which can't be changed after creation.
- bastions
Sequence[Get
Bastions Bastion] - The list of bastions.
- compartment_
id str - The unique identifier (OCID) of the compartment where the bastion is located.
- id str
- The provider-assigned unique ID for this managed resource.
- bastion_
id str - bastion_
lifecycle_ strstate - filters
Sequence[Get
Bastions Filter] - name str
- The name of the bastion, which can't be changed after creation.
- bastions List<Property Map>
- The list of bastions.
- compartment
Id String - The unique identifier (OCID) of the compartment where the bastion is located.
- id String
- The provider-assigned unique ID for this managed resource.
- bastion
Id String - bastion
Lifecycle StringState - filters List<Property Map>
- name String
- The name of the bastion, which can't be changed after creation.
Supporting Types
GetBastionsBastion
- Bastion
Type string - The type of bastion.
- Client
Cidr List<string>Block Allow Lists - A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
- Compartment
Id string - The unique identifier (OCID) of the compartment in which to list resources.
- Dictionary<string, string>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Dns
Proxy stringStatus - Flag to enable FQDN and SOCKS5 Proxy Support. Example:
ENABLED
,DISABLED
- Dictionary<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"}
- Id string
- The unique identifier (OCID) of the bastion, which can't be changed after creation.
- Lifecycle
Details string - A message describing the current state in more detail.
- Max
Session intTtl In Seconds - The maximum amount of time that any session on the bastion can remain active.
- Max
Sessions intAllowed - The maximum number of active sessions allowed on the bastion.
- Name string
- A filter to return only resources that match the entire name given.
- Phone
Book stringEntry - The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to
standard
bastions. - Private
Endpoint stringIp Address - The private IP address of the created private endpoint.
- State string
- The current state of the bastion.
- Static
Jump List<string>Host Ip Addresses - A list of IP addresses of the hosts that the bastion has access to. Not applicable to
standard
bastions. - Dictionary<string, string>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Target
Subnet stringId - The unique identifier (OCID) of the subnet that the bastion connects to.
- Target
Vcn stringId - The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.
- Time
Created string - The time the bastion was created. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- Time
Updated string - The time the bastion was updated. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- Bastion
Type string - The type of bastion.
- Client
Cidr []stringBlock Allow Lists - A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
- Compartment
Id string - The unique identifier (OCID) of the compartment in which to list resources.
- map[string]string
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- Dns
Proxy stringStatus - Flag to enable FQDN and SOCKS5 Proxy Support. Example:
ENABLED
,DISABLED
- map[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"}
- Id string
- The unique identifier (OCID) of the bastion, which can't be changed after creation.
- Lifecycle
Details string - A message describing the current state in more detail.
- Max
Session intTtl In Seconds - The maximum amount of time that any session on the bastion can remain active.
- Max
Sessions intAllowed - The maximum number of active sessions allowed on the bastion.
- Name string
- A filter to return only resources that match the entire name given.
- Phone
Book stringEntry - The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to
standard
bastions. - Private
Endpoint stringIp Address - The private IP address of the created private endpoint.
- State string
- The current state of the bastion.
- Static
Jump []stringHost Ip Addresses - A list of IP addresses of the hosts that the bastion has access to. Not applicable to
standard
bastions. - map[string]string
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- Target
Subnet stringId - The unique identifier (OCID) of the subnet that the bastion connects to.
- Target
Vcn stringId - The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.
- Time
Created string - The time the bastion was created. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- Time
Updated string - The time the bastion was updated. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- bastion
Type String - The type of bastion.
- client
Cidr List<String>Block Allow Lists - A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
- compartment
Id String - The unique identifier (OCID) of the compartment in which to list resources.
- Map<String,String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- dns
Proxy StringStatus - Flag to enable FQDN and SOCKS5 Proxy Support. Example:
ENABLED
,DISABLED
- Map<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"}
- id String
- The unique identifier (OCID) of the bastion, which can't be changed after creation.
- lifecycle
Details String - A message describing the current state in more detail.
- max
Session IntegerTtl In Seconds - The maximum amount of time that any session on the bastion can remain active.
- max
Sessions IntegerAllowed - The maximum number of active sessions allowed on the bastion.
- name String
- A filter to return only resources that match the entire name given.
- phone
Book StringEntry - The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to
standard
bastions. - private
Endpoint StringIp Address - The private IP address of the created private endpoint.
- state String
- The current state of the bastion.
- static
Jump List<String>Host Ip Addresses - A list of IP addresses of the hosts that the bastion has access to. Not applicable to
standard
bastions. - Map<String,String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- target
Subnet StringId - The unique identifier (OCID) of the subnet that the bastion connects to.
- target
Vcn StringId - The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.
- time
Created String - The time the bastion was created. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- time
Updated String - The time the bastion was updated. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- bastion
Type string - The type of bastion.
- client
Cidr string[]Block Allow Lists - A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
- compartment
Id string - The unique identifier (OCID) of the compartment in which to list resources.
- {[key: string]: string}
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- dns
Proxy stringStatus - Flag to enable FQDN and SOCKS5 Proxy Support. Example:
ENABLED
,DISABLED
- {[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"}
- id string
- The unique identifier (OCID) of the bastion, which can't be changed after creation.
- lifecycle
Details string - A message describing the current state in more detail.
- max
Session numberTtl In Seconds - The maximum amount of time that any session on the bastion can remain active.
- max
Sessions numberAllowed - The maximum number of active sessions allowed on the bastion.
- name string
- A filter to return only resources that match the entire name given.
- phone
Book stringEntry - The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to
standard
bastions. - private
Endpoint stringIp Address - The private IP address of the created private endpoint.
- state string
- The current state of the bastion.
- static
Jump string[]Host Ip Addresses - A list of IP addresses of the hosts that the bastion has access to. Not applicable to
standard
bastions. - {[key: string]: string}
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- target
Subnet stringId - The unique identifier (OCID) of the subnet that the bastion connects to.
- target
Vcn stringId - The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.
- time
Created string - The time the bastion was created. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- time
Updated string - The time the bastion was updated. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- bastion_
type str - The type of bastion.
- client_
cidr_ Sequence[str]block_ allow_ lists - A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
- compartment_
id str - The unique identifier (OCID) of the compartment in which to list resources.
- Mapping[str, str]
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- dns_
proxy_ strstatus - Flag to enable FQDN and SOCKS5 Proxy Support. Example:
ENABLED
,DISABLED
- Mapping[str, str]
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- id str
- The unique identifier (OCID) of the bastion, which can't be changed after creation.
- lifecycle_
details str - A message describing the current state in more detail.
- max_
session_ intttl_ in_ seconds - The maximum amount of time that any session on the bastion can remain active.
- max_
sessions_ intallowed - The maximum number of active sessions allowed on the bastion.
- name str
- A filter to return only resources that match the entire name given.
- phone_
book_ strentry - The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to
standard
bastions. - private_
endpoint_ strip_ address - The private IP address of the created private endpoint.
- state str
- The current state of the bastion.
- static_
jump_ Sequence[str]host_ ip_ addresses - A list of IP addresses of the hosts that the bastion has access to. Not applicable to
standard
bastions. - Mapping[str, str]
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- target_
subnet_ strid - The unique identifier (OCID) of the subnet that the bastion connects to.
- target_
vcn_ strid - The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.
- time_
created str - The time the bastion was created. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- time_
updated str - The time the bastion was updated. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- bastion
Type String - The type of bastion.
- client
Cidr List<String>Block Allow Lists - A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
- compartment
Id String - The unique identifier (OCID) of the compartment in which to list resources.
- Map<String>
- Defined tags for this resource. Each key is predefined and scoped to a namespace. Example:
{"foo-namespace.bar-key": "value"}
- dns
Proxy StringStatus - Flag to enable FQDN and SOCKS5 Proxy Support. Example:
ENABLED
,DISABLED
- Map<String>
- Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example:
{"bar-key": "value"}
- id String
- The unique identifier (OCID) of the bastion, which can't be changed after creation.
- lifecycle
Details String - A message describing the current state in more detail.
- max
Session NumberTtl In Seconds - The maximum amount of time that any session on the bastion can remain active.
- max
Sessions NumberAllowed - The maximum number of active sessions allowed on the bastion.
- name String
- A filter to return only resources that match the entire name given.
- phone
Book StringEntry - The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to
standard
bastions. - private
Endpoint StringIp Address - The private IP address of the created private endpoint.
- state String
- The current state of the bastion.
- static
Jump List<String>Host Ip Addresses - A list of IP addresses of the hosts that the bastion has access to. Not applicable to
standard
bastions. - Map<String>
- Usage of system tag keys. These predefined keys are scoped to namespaces. Example:
{"orcl-cloud.free-tier-retained": "true"}
- target
Subnet StringId - The unique identifier (OCID) of the subnet that the bastion connects to.
- target
Vcn StringId - The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.
- time
Created String - The time the bastion was created. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
- time
Updated String - The time the bastion was updated. Format is defined by RFC3339. Example:
2020-01-25T21:10:29.600Z
GetBastionsFilter
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
oci
Terraform Provider.