Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BastionClient

This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.

Hierarchy

  • BastionClient

Constructors

constructor

  • new BastionClient(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration): BastionClient

Properties

Protected _bodyDuplexMode

_bodyDuplexMode: any = undefined

Protected _circuitBreaker

_circuitBreaker: typeof Breaker | null = null

Protected _clientConfiguration

_clientConfiguration: ClientConfiguration

Protected _defaultHeaders

_defaultHeaders: any

Protected _endpoint

_endpoint: string = ""

Protected _httpClient

_httpClient: HttpClient

Protected _httpOptions

_httpOptions: any = undefined

Protected _lastSetRegionOrRegionId

_lastSetRegionOrRegionId: string = ""

Protected _realmSpecificEndpointTemplateEnabled

_realmSpecificEndpointTemplateEnabled: boolean | undefined = undefined

Protected _region

_region: Region

Protected _regionId

_regionId: string = ""

Protected _waiters

_waiters: BastionWaiter

targetService

targetService: string = "Bastion"

Static Protected endpointServiceName

endpointServiceName: string = ""

Static Protected serviceEndpointTemplate

serviceEndpointTemplate: string = "https://bastion.{region}.oci.{secondLevelDomain}"

Accessors

endpoint

  • get endpoint(): string
  • set endpoint(endpoint: string): void

logger

region

  • set region(region: Region): void
  • Sets the region to call (ex, Region.US_PHOENIX_1). Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.

    Parameters

    • region: Region

      The region of the service.

    Returns void

regionId

  • set regionId(regionId: string): void
  • Sets the regionId to call (ex, 'us-phoenix-1').

    Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}. If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1 and then call {@link #endpoint(String) endpoint}.

    Parameters

    • regionId: string

      The public region ID.

    Returns void

useRealmSpecificEndpointTemplate

  • set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean): void
  • Determines whether realm specific endpoint should be used or not. Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"

    Parameters

    • realmSpecificEndpointTemplateEnabled: boolean

      flag to enable the use of realm specific endpoint template

    Returns void

Methods

changeBastionCompartment

close

  • close(): void

createBastion

  • Creates a new bastion. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. A bastion resides in a public subnet and establishes the network infrastructure needed to connect a user to a target resource in a private subnet.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateBastion API.

    Parameters

    Returns Promise<CreateBastionResponse>

    CreateBastionResponse

createSession

  • Creates a new session in a bastion. A bastion session lets authorized users connect to a target resource for a predetermined amount of time. The Bastion service recognizes two types of sessions, managed SSH sessions and SSH port forwarding sessions. Managed SSH sessions require that the target resource has an OpenSSH server and the Oracle Cloud Agent both running.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use CreateSession API.

    Parameters

    Returns Promise<CreateSessionResponse>

    CreateSessionResponse

createWaiters

  • createWaiters(config?: common.WaiterConfiguration): BastionWaiter
  • Creates a new BastionWaiter for resources for this service.

    Parameters

    • Optional config: common.WaiterConfiguration

      The waiter configuration for termination and delay strategy

    Returns BastionWaiter

    The service waiters.

deleteBastion

  • Deletes a bastion identified by the bastion ID. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteBastion API.

    Parameters

    Returns Promise<DeleteBastionResponse>

    DeleteBastionResponse

deleteSession

  • Deletes a session identified by the session ID. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use DeleteSession API.

    Parameters

    Returns Promise<DeleteSessionResponse>

    DeleteSessionResponse

getBastion

  • Retrieves a bastion identified by the bastion ID. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetBastion API.

    Parameters

    Returns Promise<GetBastionResponse>

    GetBastionResponse

getSession

  • Retrieves a session identified by the session ID. A bastion session lets authorized users connect to a target resource for a predetermined amount of time. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetSession API.

    Parameters

    Returns Promise<GetSessionResponse>

    GetSessionResponse

getWaiters

getWorkRequest

  • Gets the status of the work request with the given ID. This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use GetWorkRequest API.

    Parameters

    Returns Promise<GetWorkRequestResponse>

    GetWorkRequestResponse

listAllBastions

  • NOTE: This function is deprecated in favor of listBastionsRecordIterator function. Creates a new async iterator which will iterate over the models.BastionSummary objects contained in responses from the listBastions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<BastionSummary>

listAllBastionsResponses

  • NOTE: This function is deprecated in favor of listBastionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listBastions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListBastionsResponse>

listAllSessions

  • NOTE: This function is deprecated in favor of listSessionsRecordIterator function. Creates a new async iterator which will iterate over the models.SessionSummary objects contained in responses from the listSessions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SessionSummary>

listAllSessionsResponses

  • NOTE: This function is deprecated in favor of listSessionsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listSessions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSessionsResponse>

listAllWorkRequestErrors

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listAllWorkRequestErrorsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestErrorsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestErrorsResponse>

listAllWorkRequestLogs

  • NOTE: This function is deprecated in favor of listWorkRequestLogsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listAllWorkRequestLogsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestLogsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestLogsResponse>

listAllWorkRequests

  • NOTE: This function is deprecated in favor of listWorkRequestsRecordIterator function. Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listAllWorkRequestsResponses

  • NOTE: This function is deprecated in favor of listWorkRequestsResponseIterator function. Creates a new async iterator which will iterate over the responses received from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListWorkRequestsResponse>

listBastions

  • 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.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListBastions API.

    Parameters

    Returns Promise<ListBastionsResponse>

    ListBastionsResponse

listBastionsRecordIterator

  • Creates a new async iterator which will iterate over the models.BastionSummary objects contained in responses from the listBastions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<BastionSummary>

listBastionsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listBastions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListBastionsResponse>

listSessions

  • Retrieves a list of SessionSummary objects for an existing bastion. Bastion sessions let authorized users connect to a target resource for a predetermined amount of time.

    This operation does not retry by default if the user has not defined a retry configuration.

    throws

    OciError when an error occurs

    example

    Click here to see how to use ListSessions API.

    Parameters

    Returns Promise<ListSessionsResponse>

    ListSessionsResponse

listSessionsRecordIterator

  • Creates a new async iterator which will iterate over the models.SessionSummary objects contained in responses from the listSessions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<SessionSummary>

listSessionsResponseIterator

  • Creates a new async iterator which will iterate over the responses received from the listSessions operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<ListSessionsResponse>

listWorkRequestErrors

listWorkRequestErrorsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestError objects contained in responses from the listWorkRequestErrors operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestError>

listWorkRequestErrorsResponseIterator

listWorkRequestLogs

listWorkRequestLogsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestLogEntry objects contained in responses from the listWorkRequestLogs operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestLogEntry>

listWorkRequestLogsResponseIterator

listWorkRequests

listWorkRequestsRecordIterator

  • Creates a new async iterator which will iterate over the models.WorkRequestSummary objects contained in responses from the listWorkRequests operation. This iterator will fetch more data from the server as needed.

    Parameters

    Returns AsyncIterableIterator<WorkRequestSummary>

listWorkRequestsResponseIterator

shutdownCircuitBreaker

  • shutdownCircuitBreaker(): void

updateBastion

  • Updates the bastion identified by the bastion ID. A bastion provides secured, public access to target resources in the cloud that you cannot otherwise reach from the internet. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateBastion API.

    Parameters

    Returns Promise<UpdateBastionResponse>

    UpdateBastionResponse

updateSession

  • Updates the session identified by the session ID. A bastion session lets authorized users connect to a target resource for a predetermined amount of time. This operation uses {@link common.OciSdkDefaultRetryConfiguration} by default if no retry configuration is defined by the user.

    throws

    OciError when an error occurs

    example

    Click here to see how to use UpdateSession API.

    Parameters

    Returns Promise<UpdateSessionResponse>

    UpdateSessionResponse