func GetActionTypeEnumStringValues() []string
GetActionTypeEnumStringValues Enumerates the set of values in String for ActionTypeEnum
func GetBastionDnsProxyStatusEnumStringValues() []string
GetBastionDnsProxyStatusEnumStringValues Enumerates the set of values in String for BastionDnsProxyStatusEnum
func GetBastionLifecycleStateEnumStringValues() []string
GetBastionLifecycleStateEnumStringValues Enumerates the set of values in String for BastionLifecycleStateEnum
func GetCreateSessionDetailsKeyTypeEnumStringValues() []string
GetCreateSessionDetailsKeyTypeEnumStringValues Enumerates the set of values in String for CreateSessionDetailsKeyTypeEnum
func GetListBastionsBastionLifecycleStateEnumStringValues() []string
GetListBastionsBastionLifecycleStateEnumStringValues Enumerates the set of values in String for ListBastionsBastionLifecycleStateEnum
func GetListBastionsSortByEnumStringValues() []string
GetListBastionsSortByEnumStringValues Enumerates the set of values in String for ListBastionsSortByEnum
func GetListBastionsSortOrderEnumStringValues() []string
GetListBastionsSortOrderEnumStringValues Enumerates the set of values in String for ListBastionsSortOrderEnum
func GetListSessionsSessionLifecycleStateEnumStringValues() []string
GetListSessionsSessionLifecycleStateEnumStringValues Enumerates the set of values in String for ListSessionsSessionLifecycleStateEnum
func GetListSessionsSortByEnumStringValues() []string
GetListSessionsSortByEnumStringValues Enumerates the set of values in String for ListSessionsSortByEnum
func GetListSessionsSortOrderEnumStringValues() []string
GetListSessionsSortOrderEnumStringValues Enumerates the set of values in String for ListSessionsSortOrderEnum
func GetOperationStatusEnumStringValues() []string
GetOperationStatusEnumStringValues Enumerates the set of values in String for OperationStatusEnum
func GetOperationTypeEnumStringValues() []string
GetOperationTypeEnumStringValues Enumerates the set of values in String for OperationTypeEnum
func GetSessionKeyTypeEnumStringValues() []string
GetSessionKeyTypeEnumStringValues Enumerates the set of values in String for SessionKeyTypeEnum
func GetSessionLifecycleStateEnumStringValues() []string
GetSessionLifecycleStateEnumStringValues Enumerates the set of values in String for SessionLifecycleStateEnum
func GetSessionTypeEnumStringValues() []string
GetSessionTypeEnumStringValues Enumerates the set of values in String for SessionTypeEnum
func GetSortOrderEnumStringValues() []string
GetSortOrderEnumStringValues Enumerates the set of values in String for SortOrderEnum
ActionTypeEnum Enum with underlying type: string
type ActionTypeEnum string
Set of constants representing the allowable values for ActionTypeEnum
const (
ActionTypeCreated ActionTypeEnum = "CREATED"
ActionTypeUpdated ActionTypeEnum = "UPDATED"
ActionTypeDeleted ActionTypeEnum = "DELETED"
ActionTypeInProgress ActionTypeEnum = "IN_PROGRESS"
ActionTypeRelated ActionTypeEnum = "RELATED"
)
func GetActionTypeEnumValues() []ActionTypeEnum
GetActionTypeEnumValues Enumerates the set of values for ActionTypeEnum
func GetMappingActionTypeEnum(val string) (ActionTypeEnum, bool)
GetMappingActionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
Bastion A bastion resource. 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.
type Bastion struct {
// The type of bastion.
BastionType *string `mandatory:"true" json:"bastionType"`
// The unique identifier (OCID) of the bastion, which can't be changed after creation.
Id *string `mandatory:"true" json:"id"`
// The name of the bastion, which can't be changed after creation.
Name *string `mandatory:"true" json:"name"`
// The unique identifier (OCID) of the compartment where the bastion is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.
TargetVcnId *string `mandatory:"true" json:"targetVcnId"`
// The unique identifier (OCID) of the subnet that the bastion connects to.
TargetSubnetId *string `mandatory:"true" json:"targetSubnetId"`
// The maximum amount of time that any session on the bastion can remain active.
MaxSessionTtlInSeconds *int `mandatory:"true" json:"maxSessionTtlInSeconds"`
// 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 *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the bastion.
LifecycleState BastionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to `standard` bastions.
PhoneBookEntry *string `mandatory:"false" json:"phoneBookEntry"`
// A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
ClientCidrBlockAllowList []string `mandatory:"false" json:"clientCidrBlockAllowList"`
// A list of IP addresses of the hosts that the bastion has access to. Not applicable to `standard` bastions.
StaticJumpHostIpAddresses []string `mandatory:"false" json:"staticJumpHostIpAddresses"`
// The private IP address of the created private endpoint.
PrivateEndpointIpAddress *string `mandatory:"false" json:"privateEndpointIpAddress"`
// The maximum number of active sessions allowed on the bastion.
MaxSessionsAllowed *int `mandatory:"false" json:"maxSessionsAllowed"`
// The current dns proxy status of the bastion.
DnsProxyStatus BastionDnsProxyStatusEnum `mandatory:"false" json:"dnsProxyStatus,omitempty"`
// 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 *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m Bastion) String() string
func (m Bastion) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BastionClient a client for Bastion
type BastionClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewBastionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client BastionClient, err error)
NewBastionClientWithConfigurationProvider Creates a new default Bastion client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewBastionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client BastionClient, err error)
NewBastionClientWithOboToken Creates a new default Bastion client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client BastionClient) ChangeBastionCompartment(ctx context.Context, request ChangeBastionCompartmentRequest) (response ChangeBastionCompartmentResponse, err error)
ChangeBastionCompartment Moves a bastion into a different compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ChangeBastionCompartment.go.html to see an example of how to use ChangeBastionCompartment API.
func (client *BastionClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client BastionClient) CreateBastion(ctx context.Context, request CreateBastionRequest) (response CreateBastionResponse, err error)
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/CreateBastion.go.html to see an example of how to use CreateBastion API.
func (client BastionClient) CreateSession(ctx context.Context, request CreateSessionRequest) (response CreateSessionResponse, err error)
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/CreateSession.go.html to see an example of how to use CreateSession API.
func (client BastionClient) DeleteBastion(ctx context.Context, request DeleteBastionRequest) (response DeleteBastionResponse, err error)
DeleteBastion Deletes a bastion identified by the bastion ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/DeleteBastion.go.html to see an example of how to use DeleteBastion API.
func (client BastionClient) DeleteSession(ctx context.Context, request DeleteSessionRequest) (response DeleteSessionResponse, err error)
DeleteSession Deletes a session identified by the session ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/DeleteSession.go.html to see an example of how to use DeleteSession API.
func (client BastionClient) GetBastion(ctx context.Context, request GetBastionRequest) (response GetBastionResponse, err error)
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/GetBastion.go.html to see an example of how to use GetBastion API. A default retry strategy applies to this operation GetBastion()
func (client BastionClient) GetSession(ctx context.Context, request GetSessionRequest) (response GetSessionResponse, err error)
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/GetSession.go.html to see an example of how to use GetSession API. A default retry strategy applies to this operation GetSession()
func (client BastionClient) GetWorkRequest(ctx context.Context, request GetWorkRequestRequest) (response GetWorkRequestResponse, err error)
GetWorkRequest Gets the status of the work request with the given ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/GetWorkRequest.go.html to see an example of how to use GetWorkRequest API.
func (client BastionClient) ListBastions(ctx context.Context, request ListBastionsRequest) (response ListBastionsResponse, err error)
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ListBastions.go.html to see an example of how to use ListBastions API.
func (client BastionClient) ListSessions(ctx context.Context, request ListSessionsRequest) (response ListSessionsResponse, err error)
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ListSessions.go.html to see an example of how to use ListSessions API.
func (client BastionClient) ListWorkRequestErrors(ctx context.Context, request ListWorkRequestErrorsRequest) (response ListWorkRequestErrorsResponse, err error)
ListWorkRequestErrors Return a (paginated) list of errors for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrors API.
func (client BastionClient) ListWorkRequestLogs(ctx context.Context, request ListWorkRequestLogsRequest) (response ListWorkRequestLogsResponse, err error)
ListWorkRequestLogs Return a (paginated) list of logs for a given work request.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogs API.
func (client BastionClient) ListWorkRequests(ctx context.Context, request ListWorkRequestsRequest) (response ListWorkRequestsResponse, err error)
ListWorkRequests Lists the work requests in a compartment.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ListWorkRequests.go.html to see an example of how to use ListWorkRequests API.
func (client *BastionClient) SetRegion(region string)
SetRegion overrides the region of this client.
func (client BastionClient) UpdateBastion(ctx context.Context, request UpdateBastionRequest) (response UpdateBastionResponse, err error)
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/UpdateBastion.go.html to see an example of how to use UpdateBastion API. A default retry strategy applies to this operation UpdateBastion()
func (client BastionClient) UpdateSession(ctx context.Context, request UpdateSessionRequest) (response UpdateSessionResponse, err error)
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.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/UpdateSession.go.html to see an example of how to use UpdateSession API. A default retry strategy applies to this operation UpdateSession()
BastionDnsProxyStatusEnum Enum with underlying type: string
type BastionDnsProxyStatusEnum string
Set of constants representing the allowable values for BastionDnsProxyStatusEnum
const (
BastionDnsProxyStatusDisabled BastionDnsProxyStatusEnum = "DISABLED"
BastionDnsProxyStatusEnabled BastionDnsProxyStatusEnum = "ENABLED"
)
func GetBastionDnsProxyStatusEnumValues() []BastionDnsProxyStatusEnum
GetBastionDnsProxyStatusEnumValues Enumerates the set of values for BastionDnsProxyStatusEnum
func GetMappingBastionDnsProxyStatusEnum(val string) (BastionDnsProxyStatusEnum, bool)
GetMappingBastionDnsProxyStatusEnum performs case Insensitive comparison on enum value and return the desired enum
BastionLifecycleStateEnum Enum with underlying type: string
type BastionLifecycleStateEnum string
Set of constants representing the allowable values for BastionLifecycleStateEnum
const (
BastionLifecycleStateCreating BastionLifecycleStateEnum = "CREATING"
BastionLifecycleStateUpdating BastionLifecycleStateEnum = "UPDATING"
BastionLifecycleStateActive BastionLifecycleStateEnum = "ACTIVE"
BastionLifecycleStateDeleting BastionLifecycleStateEnum = "DELETING"
BastionLifecycleStateDeleted BastionLifecycleStateEnum = "DELETED"
BastionLifecycleStateFailed BastionLifecycleStateEnum = "FAILED"
)
func GetBastionLifecycleStateEnumValues() []BastionLifecycleStateEnum
GetBastionLifecycleStateEnumValues Enumerates the set of values for BastionLifecycleStateEnum
func GetMappingBastionLifecycleStateEnum(val string) (BastionLifecycleStateEnum, bool)
GetMappingBastionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
BastionSummary Summary information for a bastion resource. 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.
type BastionSummary struct {
// The type of bastion.
BastionType *string `mandatory:"true" json:"bastionType"`
// The unique identifier (OCID) of the bastion, which can't be changed after creation.
Id *string `mandatory:"true" json:"id"`
// The name of the bastion, which can't be changed after creation.
Name *string `mandatory:"true" json:"name"`
// The unique identifier (OCID) of the compartment where the bastion is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The unique identifier (OCID) of the virtual cloud network (VCN) that the bastion connects to.
TargetVcnId *string `mandatory:"true" json:"targetVcnId"`
// The unique identifier (OCID) of the subnet that the bastion connects to.
TargetSubnetId *string `mandatory:"true" json:"targetSubnetId"`
// 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 *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the bastion.
LifecycleState BastionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The current dns proxy status of the bastion.
DnsProxyStatus BastionDnsProxyStatusEnum `mandatory:"false" json:"dnsProxyStatus,omitempty"`
// 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 *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current state in more detail.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
// Usage of system tag keys. These predefined keys are scoped to namespaces.
// Example: `{"orcl-cloud": {"free-tier-retained": "true"}}`
SystemTags map[string]map[string]interface{} `mandatory:"false" json:"systemTags"`
}
func (m BastionSummary) String() string
func (m BastionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeBastionCompartmentDetails Details about the compartment that the bastion should move to.
type ChangeBastionCompartmentDetails struct {
// The unique identifier (OCID) of the compartment that the bastion should move to.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
}
func (m ChangeBastionCompartmentDetails) String() string
func (m ChangeBastionCompartmentDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeBastionCompartmentRequest wrapper for the ChangeBastionCompartment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ChangeBastionCompartment.go.html to see an example of how to use ChangeBastionCompartmentRequest.
type ChangeBastionCompartmentRequest struct {
// The unique identifier (OCID) of the bastion.
BastionId *string `mandatory:"true" contributesTo:"path" name:"bastionId"`
// The compartment information to be updated.
ChangeBastionCompartmentDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ChangeBastionCompartmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ChangeBastionCompartmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ChangeBastionCompartmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ChangeBastionCompartmentRequest) String() string
func (request ChangeBastionCompartmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ChangeBastionCompartmentResponse wrapper for the ChangeBastionCompartment operation
type ChangeBastionCompartmentResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ChangeBastionCompartmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ChangeBastionCompartmentResponse) String() string
CreateBastionDetails The configuration details for 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.
type CreateBastionDetails struct {
// The type of bastion. Use `standard`.
BastionType *string `mandatory:"true" json:"bastionType"`
// The unique identifier (OCID) of the compartment where the bastion is located.
CompartmentId *string `mandatory:"true" json:"compartmentId"`
// The unique identifier (OCID) of the subnet that the bastion connects to.
TargetSubnetId *string `mandatory:"true" json:"targetSubnetId"`
// The name of the bastion, which can't be changed after creation.
Name *string `mandatory:"false" json:"name"`
// The phonebook entry of the customer's team, which can't be changed after creation. Not applicable to `standard` bastions.
PhoneBookEntry *string `mandatory:"false" json:"phoneBookEntry"`
// A list of IP addresses of the hosts that the bastion has access to. Not applicable to `standard` bastions.
StaticJumpHostIpAddresses []string `mandatory:"false" json:"staticJumpHostIpAddresses"`
// A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
ClientCidrBlockAllowList []string `mandatory:"false" json:"clientCidrBlockAllowList"`
// The maximum amount of time that any session on the bastion can remain active.
MaxSessionTtlInSeconds *int `mandatory:"false" json:"maxSessionTtlInSeconds"`
// The desired dns proxy status of the bastion.
DnsProxyStatus BastionDnsProxyStatusEnum `mandatory:"false" json:"dnsProxyStatus,omitempty"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m CreateBastionDetails) String() string
func (m CreateBastionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBastionRequest wrapper for the CreateBastion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/CreateBastion.go.html to see an example of how to use CreateBastionRequest.
type CreateBastionRequest struct {
// Details for the new bastion.
CreateBastionDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateBastionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateBastionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateBastionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateBastionRequest) String() string
func (request CreateBastionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateBastionResponse wrapper for the CreateBastion operation
type CreateBastionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Bastion instance
Bastion `presentIn:"body"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// this contains the full URI for the get request, e.g. "https://iaas.us-phoenix-1.oraclecloud.com/20210331/bastions/<some-ocid>"
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateBastionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateBastionResponse) String() string
CreateDynamicPortForwardingSessionTargetResourceDetails Details about a dynamic port forwarding session for a target subnet.
type CreateDynamicPortForwardingSessionTargetResourceDetails struct {
}
func (m CreateDynamicPortForwardingSessionTargetResourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateDynamicPortForwardingSessionTargetResourceDetails) String() string
func (m CreateDynamicPortForwardingSessionTargetResourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateManagedSshSessionTargetResourceDetails Details about a managed SSH session for a target resource.
type CreateManagedSshSessionTargetResourceDetails struct {
// The name of the user on the target resource operating system that the session uses for the connection.
TargetResourceOperatingSystemUserName *string `mandatory:"true" json:"targetResourceOperatingSystemUserName"`
// The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.
TargetResourceId *string `mandatory:"true" json:"targetResourceId"`
// The private IP address of the target resource that the session connects to.
TargetResourcePrivateIpAddress *string `mandatory:"false" json:"targetResourcePrivateIpAddress"`
// The port number to connect to on the target resource.
TargetResourcePort *int `mandatory:"false" json:"targetResourcePort"`
}
func (m CreateManagedSshSessionTargetResourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreateManagedSshSessionTargetResourceDetails) String() string
func (m CreateManagedSshSessionTargetResourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreatePortForwardingSessionTargetResourceDetails Details about a port forwarding session for a target resource.
type CreatePortForwardingSessionTargetResourceDetails struct {
// The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.
TargetResourceId *string `mandatory:"false" json:"targetResourceId"`
// The private IP address of the target resource that the session connects to.
TargetResourcePrivateIpAddress *string `mandatory:"false" json:"targetResourcePrivateIpAddress"`
// The Fully Qualified Domain Name of the target resource that the session connects to.
TargetResourceFqdn *string `mandatory:"false" json:"targetResourceFqdn"`
// The port number to connect to on the target resource.
TargetResourcePort *int `mandatory:"false" json:"targetResourcePort"`
}
func (m CreatePortForwardingSessionTargetResourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m CreatePortForwardingSessionTargetResourceDetails) String() string
func (m CreatePortForwardingSessionTargetResourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSessionDetails The configuration details for a new bastion session. A 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.
type CreateSessionDetails struct {
// The unique identifier (OCID) of the bastion on which to create this session.
BastionId *string `mandatory:"true" json:"bastionId"`
TargetResourceDetails CreateSessionTargetResourceDetails `mandatory:"true" json:"targetResourceDetails"`
KeyDetails *PublicKeyDetails `mandatory:"true" json:"keyDetails"`
// The name of the session.
DisplayName *string `mandatory:"false" json:"displayName"`
// The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format.
KeyType CreateSessionDetailsKeyTypeEnum `mandatory:"false" json:"keyType,omitempty"`
// The amount of time the session can remain active.
SessionTtlInSeconds *int `mandatory:"false" json:"sessionTtlInSeconds"`
}
func (m CreateSessionDetails) String() string
func (m *CreateSessionDetails) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m CreateSessionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSessionDetailsKeyTypeEnum Enum with underlying type: string
type CreateSessionDetailsKeyTypeEnum string
Set of constants representing the allowable values for CreateSessionDetailsKeyTypeEnum
const (
CreateSessionDetailsKeyTypePub CreateSessionDetailsKeyTypeEnum = "PUB"
)
func GetCreateSessionDetailsKeyTypeEnumValues() []CreateSessionDetailsKeyTypeEnum
GetCreateSessionDetailsKeyTypeEnumValues Enumerates the set of values for CreateSessionDetailsKeyTypeEnum
func GetMappingCreateSessionDetailsKeyTypeEnum(val string) (CreateSessionDetailsKeyTypeEnum, bool)
GetMappingCreateSessionDetailsKeyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
CreateSessionRequest wrapper for the CreateSession operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/CreateSession.go.html to see an example of how to use CreateSessionRequest.
type CreateSessionRequest struct {
// Details for the new session.
CreateSessionDetails `contributesTo:"body"`
// A token that uniquely identifies a request so it can be retried in case of a timeout or
// server error without risk of executing that same action again. Retry tokens expire after 24
// hours, but can be invalidated before then due to conflicting operations. For example, if a resource
// has been deleted and purged from the system, then a retry of the original creation request
// might be rejected.
OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request CreateSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request CreateSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request CreateSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request CreateSessionRequest) String() string
func (request CreateSessionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CreateSessionResponse wrapper for the CreateSession operation
type CreateSessionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Session instance
Session `presentIn:"body"`
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// this contains the full URI for the get request, e.g. "https://iaas.us-phoenix-1.oraclecloud.com/20210331/bastions/<some-ocid>"
Location *string `presentIn:"header" name:"location"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
}
func (response CreateSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response CreateSessionResponse) String() string
CreateSessionTargetResourceDetails Details about a bastion session's target resource.
type CreateSessionTargetResourceDetails interface {
}
DeleteBastionRequest wrapper for the DeleteBastion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/DeleteBastion.go.html to see an example of how to use DeleteBastionRequest.
type DeleteBastionRequest struct {
// The unique identifier (OCID) of the bastion.
BastionId *string `mandatory:"true" contributesTo:"path" name:"bastionId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteBastionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteBastionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteBastionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteBastionRequest) String() string
func (request DeleteBastionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteBastionResponse wrapper for the DeleteBastion operation
type DeleteBastionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteBastionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteBastionResponse) String() string
DeleteSessionRequest wrapper for the DeleteSession operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/DeleteSession.go.html to see an example of how to use DeleteSessionRequest.
type DeleteSessionRequest struct {
// The unique identifier (OCID) of the session.
SessionId *string `mandatory:"true" contributesTo:"path" name:"sessionId"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request DeleteSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request DeleteSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request DeleteSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request DeleteSessionRequest) String() string
func (request DeleteSessionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
DeleteSessionResponse wrapper for the DeleteSession operation
type DeleteSessionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response DeleteSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response DeleteSessionResponse) String() string
DynamicPortForwardingSessionTargetResourceDetails Details about a dynamic port forwarding session for a target subnet.
type DynamicPortForwardingSessionTargetResourceDetails struct {
}
func (m DynamicPortForwardingSessionTargetResourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m DynamicPortForwardingSessionTargetResourceDetails) String() string
func (m DynamicPortForwardingSessionTargetResourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetBastionRequest wrapper for the GetBastion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/GetBastion.go.html to see an example of how to use GetBastionRequest.
type GetBastionRequest struct {
// The unique identifier (OCID) of the bastion.
BastionId *string `mandatory:"true" contributesTo:"path" name:"bastionId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetBastionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetBastionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetBastionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetBastionRequest) String() string
func (request GetBastionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetBastionResponse wrapper for the GetBastion operation
type GetBastionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Bastion instance
Bastion `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetBastionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetBastionResponse) String() string
GetSessionRequest wrapper for the GetSession operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/GetSession.go.html to see an example of how to use GetSessionRequest.
type GetSessionRequest struct {
// The unique identifier (OCID) of the session.
SessionId *string `mandatory:"true" contributesTo:"path" name:"sessionId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSessionRequest) String() string
func (request GetSessionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSessionResponse wrapper for the GetSession operation
type GetSessionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Session instance
Session `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSessionResponse) String() string
GetWorkRequestRequest wrapper for the GetWorkRequest operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/GetWorkRequest.go.html to see an example of how to use GetWorkRequestRequest.
type GetWorkRequestRequest struct {
// The unique identifier (OCID) of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetWorkRequestRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetWorkRequestRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetWorkRequestRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetWorkRequestRequest) String() string
func (request GetWorkRequestRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetWorkRequestResponse wrapper for the GetWorkRequest operation
type GetWorkRequestResponse struct {
// The underlying http response
RawResponse *http.Response
// The WorkRequest instance
WorkRequest `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// A decimal number representing the number of seconds the client should wait before polling this endpoint again.
RetryAfter *float32 `presentIn:"header" name:"retry-after"`
}
func (response GetWorkRequestResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetWorkRequestResponse) String() string
ListBastionsBastionLifecycleStateEnum Enum with underlying type: string
type ListBastionsBastionLifecycleStateEnum string
Set of constants representing the allowable values for ListBastionsBastionLifecycleStateEnum
const (
ListBastionsBastionLifecycleStateCreating ListBastionsBastionLifecycleStateEnum = "CREATING"
ListBastionsBastionLifecycleStateUpdating ListBastionsBastionLifecycleStateEnum = "UPDATING"
ListBastionsBastionLifecycleStateActive ListBastionsBastionLifecycleStateEnum = "ACTIVE"
ListBastionsBastionLifecycleStateDeleting ListBastionsBastionLifecycleStateEnum = "DELETING"
ListBastionsBastionLifecycleStateDeleted ListBastionsBastionLifecycleStateEnum = "DELETED"
ListBastionsBastionLifecycleStateFailed ListBastionsBastionLifecycleStateEnum = "FAILED"
)
func GetListBastionsBastionLifecycleStateEnumValues() []ListBastionsBastionLifecycleStateEnum
GetListBastionsBastionLifecycleStateEnumValues Enumerates the set of values for ListBastionsBastionLifecycleStateEnum
func GetMappingListBastionsBastionLifecycleStateEnum(val string) (ListBastionsBastionLifecycleStateEnum, bool)
GetMappingListBastionsBastionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListBastionsRequest wrapper for the ListBastions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ListBastions.go.html to see an example of how to use ListBastionsRequest.
type ListBastionsRequest struct {
// The unique identifier (OCID) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
BastionLifecycleState ListBastionsBastionLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"bastionLifecycleState" omitEmpty:"true"`
// The unique identifier (OCID) of the bastion in which to list resources.
BastionId *string `mandatory:"false" contributesTo:"query" name:"bastionId"`
// A filter to return only resources that match the entire name given.
Name *string `mandatory:"false" contributesTo:"query" name:"name"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListBastionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default.
SortBy ListBastionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListBastionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBastionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBastionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBastionsRequest) String() string
func (request ListBastionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListBastionsResponse wrapper for the ListBastions operation
type ListBastionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []BastionSummary instances
Items []BastionSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListBastionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBastionsResponse) String() string
ListBastionsSortByEnum Enum with underlying type: string
type ListBastionsSortByEnum string
Set of constants representing the allowable values for ListBastionsSortByEnum
const (
ListBastionsSortByTimecreated ListBastionsSortByEnum = "timeCreated"
ListBastionsSortByName ListBastionsSortByEnum = "name"
)
func GetListBastionsSortByEnumValues() []ListBastionsSortByEnum
GetListBastionsSortByEnumValues Enumerates the set of values for ListBastionsSortByEnum
func GetMappingListBastionsSortByEnum(val string) (ListBastionsSortByEnum, bool)
GetMappingListBastionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBastionsSortOrderEnum Enum with underlying type: string
type ListBastionsSortOrderEnum string
Set of constants representing the allowable values for ListBastionsSortOrderEnum
const (
ListBastionsSortOrderAsc ListBastionsSortOrderEnum = "ASC"
ListBastionsSortOrderDesc ListBastionsSortOrderEnum = "DESC"
)
func GetListBastionsSortOrderEnumValues() []ListBastionsSortOrderEnum
GetListBastionsSortOrderEnumValues Enumerates the set of values for ListBastionsSortOrderEnum
func GetMappingListBastionsSortOrderEnum(val string) (ListBastionsSortOrderEnum, bool)
GetMappingListBastionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSessionsRequest wrapper for the ListSessions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ListSessions.go.html to see an example of how to use ListSessionsRequest.
type ListSessionsRequest struct {
// The unique identifier (OCID) of the bastion in which to list sessions.
BastionId *string `mandatory:"true" contributesTo:"query" name:"bastionId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// A filter to return only resources that match the entire display name given.
DisplayName *string `mandatory:"false" contributesTo:"query" name:"displayName"`
// A filter to return only resources their lifecycleState matches the given lifecycleState.
SessionLifecycleState ListSessionsSessionLifecycleStateEnum `mandatory:"false" contributesTo:"query" name:"sessionLifecycleState" omitEmpty:"true"`
// The unique identifier (OCID) of the session in which to list resources.
SessionId *string `mandatory:"false" contributesTo:"query" name:"sessionId"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either 'asc' or 'desc'.
SortOrder ListSessionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.
SortBy ListSessionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSessionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSessionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSessionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSessionsRequest) String() string
func (request ListSessionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSessionsResponse wrapper for the ListSessions operation
type ListSessionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []SessionSummary instances
Items []SessionSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListSessionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSessionsResponse) String() string
ListSessionsSessionLifecycleStateEnum Enum with underlying type: string
type ListSessionsSessionLifecycleStateEnum string
Set of constants representing the allowable values for ListSessionsSessionLifecycleStateEnum
const (
ListSessionsSessionLifecycleStateCreating ListSessionsSessionLifecycleStateEnum = "CREATING"
ListSessionsSessionLifecycleStateActive ListSessionsSessionLifecycleStateEnum = "ACTIVE"
ListSessionsSessionLifecycleStateDeleting ListSessionsSessionLifecycleStateEnum = "DELETING"
ListSessionsSessionLifecycleStateDeleted ListSessionsSessionLifecycleStateEnum = "DELETED"
ListSessionsSessionLifecycleStateFailed ListSessionsSessionLifecycleStateEnum = "FAILED"
)
func GetListSessionsSessionLifecycleStateEnumValues() []ListSessionsSessionLifecycleStateEnum
GetListSessionsSessionLifecycleStateEnumValues Enumerates the set of values for ListSessionsSessionLifecycleStateEnum
func GetMappingListSessionsSessionLifecycleStateEnum(val string) (ListSessionsSessionLifecycleStateEnum, bool)
GetMappingListSessionsSessionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
ListSessionsSortByEnum Enum with underlying type: string
type ListSessionsSortByEnum string
Set of constants representing the allowable values for ListSessionsSortByEnum
const (
ListSessionsSortByTimecreated ListSessionsSortByEnum = "timeCreated"
ListSessionsSortByDisplayname ListSessionsSortByEnum = "displayName"
)
func GetListSessionsSortByEnumValues() []ListSessionsSortByEnum
GetListSessionsSortByEnumValues Enumerates the set of values for ListSessionsSortByEnum
func GetMappingListSessionsSortByEnum(val string) (ListSessionsSortByEnum, bool)
GetMappingListSessionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSessionsSortOrderEnum Enum with underlying type: string
type ListSessionsSortOrderEnum string
Set of constants representing the allowable values for ListSessionsSortOrderEnum
const (
ListSessionsSortOrderAsc ListSessionsSortOrderEnum = "ASC"
ListSessionsSortOrderDesc ListSessionsSortOrderEnum = "DESC"
)
func GetListSessionsSortOrderEnumValues() []ListSessionsSortOrderEnum
GetListSessionsSortOrderEnumValues Enumerates the set of values for ListSessionsSortOrderEnum
func GetMappingListSessionsSortOrderEnum(val string) (ListSessionsSortOrderEnum, bool)
GetMappingListSessionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListWorkRequestErrorsRequest wrapper for the ListWorkRequestErrors operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ListWorkRequestErrors.go.html to see an example of how to use ListWorkRequestErrorsRequest.
type ListWorkRequestErrorsRequest struct {
// The unique identifier (OCID) of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestErrorsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestErrorsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestErrorsRequest) String() string
func (request ListWorkRequestErrorsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestErrorsResponse wrapper for the ListWorkRequestErrors operation
type ListWorkRequestErrorsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestError instances
Items []WorkRequestError `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestErrorsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestErrorsResponse) String() string
ListWorkRequestLogsRequest wrapper for the ListWorkRequestLogs operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ListWorkRequestLogs.go.html to see an example of how to use ListWorkRequestLogsRequest.
type ListWorkRequestLogsRequest struct {
// The unique identifier (OCID) of the asynchronous request.
WorkRequestId *string `mandatory:"true" contributesTo:"path" name:"workRequestId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestLogsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestLogsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestLogsRequest) String() string
func (request ListWorkRequestLogsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestLogsResponse wrapper for the ListWorkRequestLogs operation
type ListWorkRequestLogsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestLogEntry instances
Items []WorkRequestLogEntry `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListWorkRequestLogsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestLogsResponse) String() string
ListWorkRequestsRequest wrapper for the ListWorkRequests operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/ListWorkRequests.go.html to see an example of how to use ListWorkRequestsRequest.
type ListWorkRequestsRequest struct {
// The unique identifier (OCID) of the compartment in which to list resources.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The maximum number of items to return.
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListWorkRequestsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListWorkRequestsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListWorkRequestsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListWorkRequestsRequest) String() string
func (request ListWorkRequestsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListWorkRequestsResponse wrapper for the ListWorkRequests operation
type ListWorkRequestsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []WorkRequestSummary instances
Items []WorkRequestSummary `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
}
func (response ListWorkRequestsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListWorkRequestsResponse) String() string
ManagedSshSessionTargetResourceDetails Details about a managed SSH session for a target resource.
type ManagedSshSessionTargetResourceDetails struct {
// The name of the user on the target resource operating system that the session uses for the connection.
TargetResourceOperatingSystemUserName *string `mandatory:"true" json:"targetResourceOperatingSystemUserName"`
// The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.
TargetResourceId *string `mandatory:"true" json:"targetResourceId"`
// The display name of the target Compute instance that the session connects to.
TargetResourceDisplayName *string `mandatory:"true" json:"targetResourceDisplayName"`
// The private IP address of the target resource that the session connects to.
TargetResourcePrivateIpAddress *string `mandatory:"false" json:"targetResourcePrivateIpAddress"`
// The port number to connect to on the target resource.
TargetResourcePort *int `mandatory:"false" json:"targetResourcePort"`
}
func (m ManagedSshSessionTargetResourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m ManagedSshSessionTargetResourceDetails) String() string
func (m ManagedSshSessionTargetResourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OperationStatusEnum Enum with underlying type: string
type OperationStatusEnum string
Set of constants representing the allowable values for OperationStatusEnum
const (
OperationStatusAccepted OperationStatusEnum = "ACCEPTED"
OperationStatusInProgress OperationStatusEnum = "IN_PROGRESS"
OperationStatusFailed OperationStatusEnum = "FAILED"
OperationStatusSucceeded OperationStatusEnum = "SUCCEEDED"
OperationStatusCanceling OperationStatusEnum = "CANCELING"
OperationStatusCanceled OperationStatusEnum = "CANCELED"
)
func GetMappingOperationStatusEnum(val string) (OperationStatusEnum, bool)
GetMappingOperationStatusEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationStatusEnumValues() []OperationStatusEnum
GetOperationStatusEnumValues Enumerates the set of values for OperationStatusEnum
OperationTypeEnum Enum with underlying type: string
type OperationTypeEnum string
Set of constants representing the allowable values for OperationTypeEnum
const (
OperationTypeCreateBastion OperationTypeEnum = "CREATE_BASTION"
OperationTypeUpdateBastion OperationTypeEnum = "UPDATE_BASTION"
OperationTypeDeleteBastion OperationTypeEnum = "DELETE_BASTION"
OperationTypeCreateSession OperationTypeEnum = "CREATE_SESSION"
OperationTypeDeleteSession OperationTypeEnum = "DELETE_SESSION"
)
func GetMappingOperationTypeEnum(val string) (OperationTypeEnum, bool)
GetMappingOperationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetOperationTypeEnumValues() []OperationTypeEnum
GetOperationTypeEnumValues Enumerates the set of values for OperationTypeEnum
PortForwardingSessionTargetResourceDetails Details about a port forwarding session for a target resource.
type PortForwardingSessionTargetResourceDetails struct {
// The unique identifier (OCID) of the target resource (a Compute instance, for example) that the session connects to.
TargetResourceId *string `mandatory:"false" json:"targetResourceId"`
// The private IP address of the target resource that the session connects to.
TargetResourcePrivateIpAddress *string `mandatory:"false" json:"targetResourcePrivateIpAddress"`
// The display name of the target Compute instance that the session connects to.
TargetResourceDisplayName *string `mandatory:"false" json:"targetResourceDisplayName"`
// The Fully Qualified Domain Name of the target resource that the session connects to.
TargetResourceFqdn *string `mandatory:"false" json:"targetResourceFqdn"`
// The port number to connect to on the target resource.
TargetResourcePort *int `mandatory:"false" json:"targetResourcePort"`
}
func (m PortForwardingSessionTargetResourceDetails) MarshalJSON() (buff []byte, e error)
MarshalJSON marshals to json representation
func (m PortForwardingSessionTargetResourceDetails) String() string
func (m PortForwardingSessionTargetResourceDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
PublicKeyDetails Public key details for a bastion session.
type PublicKeyDetails struct {
// 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 `mandatory:"true" json:"publicKeyContent"`
}
func (m PublicKeyDetails) String() string
func (m PublicKeyDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
Session A bastion session resource. A bastion session lets authorized users connect to a target resource using a Secure Shell (SSH) for a predetermined amount of time.
type Session struct {
// The unique identifier (OCID) of the session, which can't be changed after creation.
Id *string `mandatory:"true" json:"id"`
// The unique identifier (OCID) of the bastion that is hosting this session.
BastionId *string `mandatory:"true" json:"bastionId"`
// The name of the bastion that is hosting this session.
BastionName *string `mandatory:"true" json:"bastionName"`
TargetResourceDetails TargetResourceDetails `mandatory:"true" json:"targetResourceDetails"`
KeyDetails *PublicKeyDetails `mandatory:"true" json:"keyDetails"`
// 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 *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the session.
LifecycleState SessionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The amount of time the session can remain active.
SessionTtlInSeconds *int `mandatory:"true" json:"sessionTtlInSeconds"`
// The name of the session.
DisplayName *string `mandatory:"false" json:"displayName"`
// The username that the session uses to connect to the target resource.
BastionUserName *string `mandatory:"false" json:"bastionUserName"`
// The connection message for the session.
SshMetadata map[string]string `mandatory:"false" json:"sshMetadata"`
// The type of the key used to connect to the session. PUB is a standard public key in OpenSSH format.
KeyType SessionKeyTypeEnum `mandatory:"false" json:"keyType,omitempty"`
// The public key of the bastion host. You can use this to verify that you're connecting to the correct bastion.
BastionPublicHostKeyInfo *string `mandatory:"false" json:"bastionPublicHostKeyInfo"`
// 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 *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current session state in more detail.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m Session) String() string
func (m *Session) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m Session) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SessionKeyTypeEnum Enum with underlying type: string
type SessionKeyTypeEnum string
Set of constants representing the allowable values for SessionKeyTypeEnum
const (
SessionKeyTypePub SessionKeyTypeEnum = "PUB"
)
func GetMappingSessionKeyTypeEnum(val string) (SessionKeyTypeEnum, bool)
GetMappingSessionKeyTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSessionKeyTypeEnumValues() []SessionKeyTypeEnum
GetSessionKeyTypeEnumValues Enumerates the set of values for SessionKeyTypeEnum
SessionLifecycleStateEnum Enum with underlying type: string
type SessionLifecycleStateEnum string
Set of constants representing the allowable values for SessionLifecycleStateEnum
const (
SessionLifecycleStateCreating SessionLifecycleStateEnum = "CREATING"
SessionLifecycleStateActive SessionLifecycleStateEnum = "ACTIVE"
SessionLifecycleStateDeleting SessionLifecycleStateEnum = "DELETING"
SessionLifecycleStateDeleted SessionLifecycleStateEnum = "DELETED"
SessionLifecycleStateFailed SessionLifecycleStateEnum = "FAILED"
)
func GetMappingSessionLifecycleStateEnum(val string) (SessionLifecycleStateEnum, bool)
GetMappingSessionLifecycleStateEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSessionLifecycleStateEnumValues() []SessionLifecycleStateEnum
GetSessionLifecycleStateEnumValues Enumerates the set of values for SessionLifecycleStateEnum
SessionSummary Summary information for a bastion session resource.
type SessionSummary struct {
// The unique identifier (OCID) of the session, which can't be changed after creation.
Id *string `mandatory:"true" json:"id"`
// The name of the bastion that is hosting this session.
BastionName *string `mandatory:"true" json:"bastionName"`
// The unique identifier (OCID) of the bastion that is hosting this session.
BastionId *string `mandatory:"true" json:"bastionId"`
TargetResourceDetails TargetResourceDetails `mandatory:"true" json:"targetResourceDetails"`
// 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 *common.SDKTime `mandatory:"true" json:"timeCreated"`
// The current state of the session.
LifecycleState SessionLifecycleStateEnum `mandatory:"true" json:"lifecycleState"`
// The amount of time the session can remain active.
SessionTtlInSeconds *int `mandatory:"true" json:"sessionTtlInSeconds"`
// The name of the session.
DisplayName *string `mandatory:"false" json:"displayName"`
// 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 *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// A message describing the current session state in more detail.
LifecycleDetails *string `mandatory:"false" json:"lifecycleDetails"`
}
func (m SessionSummary) String() string
func (m *SessionSummary) UnmarshalJSON(data []byte) (e error)
UnmarshalJSON unmarshals from json
func (m SessionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SessionTypeEnum Enum with underlying type: string
type SessionTypeEnum string
Set of constants representing the allowable values for SessionTypeEnum
const (
SessionTypeManagedSsh SessionTypeEnum = "MANAGED_SSH"
SessionTypePortForwarding SessionTypeEnum = "PORT_FORWARDING"
SessionTypeDynamicPortForwarding SessionTypeEnum = "DYNAMIC_PORT_FORWARDING"
)
func GetMappingSessionTypeEnum(val string) (SessionTypeEnum, bool)
GetMappingSessionTypeEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSessionTypeEnumValues() []SessionTypeEnum
GetSessionTypeEnumValues Enumerates the set of values for SessionTypeEnum
SortOrderEnum Enum with underlying type: string
type SortOrderEnum string
Set of constants representing the allowable values for SortOrderEnum
const (
SortOrderAsc SortOrderEnum = "ASC"
SortOrderDesc SortOrderEnum = "DESC"
)
func GetMappingSortOrderEnum(val string) (SortOrderEnum, bool)
GetMappingSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
func GetSortOrderEnumValues() []SortOrderEnum
GetSortOrderEnumValues Enumerates the set of values for SortOrderEnum
TargetResourceDetails Details about a bastion session's target resource.
type TargetResourceDetails interface {
}
UpdateBastionDetails The configuration to update on an existing bastion.
type UpdateBastionDetails struct {
// The maximum amount of time that any session on the bastion can remain active.
MaxSessionTtlInSeconds *int `mandatory:"false" json:"maxSessionTtlInSeconds"`
// A list of IP addresses of the hosts that the bastion has access to. Not applicable to `standard` bastions.
StaticJumpHostIpAddresses []string `mandatory:"false" json:"staticJumpHostIpAddresses"`
// A list of address ranges in CIDR notation that you want to allow to connect to sessions hosted by this bastion.
ClientCidrBlockAllowList []string `mandatory:"false" json:"clientCidrBlockAllowList"`
// Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only.
// Example: `{"bar-key": "value"}`
FreeformTags map[string]string `mandatory:"false" json:"freeformTags"`
// Defined tags for this resource. Each key is predefined and scoped to a namespace.
// Example: `{"foo-namespace": {"bar-key": "value"}}`
DefinedTags map[string]map[string]interface{} `mandatory:"false" json:"definedTags"`
}
func (m UpdateBastionDetails) String() string
func (m UpdateBastionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateBastionRequest wrapper for the UpdateBastion operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/UpdateBastion.go.html to see an example of how to use UpdateBastionRequest.
type UpdateBastionRequest struct {
// The unique identifier (OCID) of the bastion.
BastionId *string `mandatory:"true" contributesTo:"path" name:"bastionId"`
// The bastion information to be updated.
UpdateBastionDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateBastionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateBastionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateBastionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateBastionRequest) String() string
func (request UpdateBastionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateBastionResponse wrapper for the UpdateBastion operation
type UpdateBastionResponse struct {
// The underlying http response
RawResponse *http.Response
// Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation.
OpcWorkRequestId *string `presentIn:"header" name:"opc-work-request-id"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateBastionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateBastionResponse) String() string
UpdateSessionDetails The session information to be updated.
type UpdateSessionDetails struct {
// The name of the session.
DisplayName *string `mandatory:"false" json:"displayName"`
}
func (m UpdateSessionDetails) String() string
func (m UpdateSessionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSessionRequest wrapper for the UpdateSession operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/bastion/UpdateSession.go.html to see an example of how to use UpdateSessionRequest.
type UpdateSessionRequest struct {
// The unique identifier (OCID) of the session.
SessionId *string `mandatory:"true" contributesTo:"path" name:"sessionId"`
// The session information to be updated.
UpdateSessionDetails `contributesTo:"body"`
// For optimistic concurrency control. In the PUT or DELETE call
// for a resource, set the `if-match` parameter to the value of the
// etag from a previous GET or POST response for that resource.
// The resource will be updated or deleted only if the etag you
// provide matches the resource's current etag value.
IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`
// The client request ID for tracing.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request UpdateSessionRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request UpdateSessionRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request UpdateSessionRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request UpdateSessionRequest) String() string
func (request UpdateSessionRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UpdateSessionResponse wrapper for the UpdateSession operation
type UpdateSessionResponse struct {
// The underlying http response
RawResponse *http.Response
// The Session instance
Session `presentIn:"body"`
// For optimistic concurrency control. See `if-match`.
Etag *string `presentIn:"header" name:"etag"`
// Unique Oracle-assigned identifier for the request. If you need to contact
// Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response UpdateSessionResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response UpdateSessionResponse) String() string
WorkRequest A description of workrequest status.
type WorkRequest struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The unique identifier (OCID) of the work request.
Id *string `mandatory:"true" json:"id"`
// 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 affects 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 `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequest) String() string
func (m WorkRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestError An error encountered while executing a work request.
type WorkRequestError struct {
// A machine-usable code for the error that occurred. Error codes are listed on
// (https://docs.oracle.com/iaas/Content/API/References/apierrors.htm)
Code *string `mandatory:"true" json:"code"`
// A human readable description of the issue encountered.
Message *string `mandatory:"true" json:"message"`
// The time the error occurred. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestError) String() string
func (m WorkRequestError) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestLogEntry A log message from the execution of a work request.
type WorkRequestLogEntry struct {
// Human-readable log message.
Message *string `mandatory:"true" json:"message"`
// The time the log message was written. An RFC3339 formatted datetime string.
Timestamp *common.SDKTime `mandatory:"true" json:"timestamp"`
}
func (m WorkRequestLogEntry) String() string
func (m WorkRequestLogEntry) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestResource A resource created or operated on by a work request.
type WorkRequestResource struct {
// The resource type the work request affects.
EntityType *string `mandatory:"true" json:"entityType"`
// 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 ActionTypeEnum `mandatory:"true" json:"actionType"`
// The unique identifier (OCID) of the resource that the work request affects.
Identifier *string `mandatory:"true" json:"identifier"`
// The URI path that the user can do a GET on to access the resource metadata.
EntityUri *string `mandatory:"false" json:"entityUri"`
}
func (m WorkRequestResource) String() string
func (m WorkRequestResource) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
WorkRequestSummary A description of workrequest status.
type WorkRequestSummary struct {
// Type of the work request.
OperationType OperationTypeEnum `mandatory:"true" json:"operationType"`
// Status of current work request.
Status OperationStatusEnum `mandatory:"true" json:"status"`
// The unique identifier (OCID) of the work request.
Id *string `mandatory:"true" json:"id"`
// 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 affects 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 `mandatory:"true" json:"compartmentId"`
// The resources affected by this work request.
Resources []WorkRequestResource `mandatory:"true" json:"resources"`
// Percentage of the request completed.
PercentComplete *float32 `mandatory:"true" json:"percentComplete"`
// The date and time the request was created, as described in
// RFC 3339 (https://tools.ietf.org/rfc/rfc3339), section 14.29.
TimeAccepted *common.SDKTime `mandatory:"true" json:"timeAccepted"`
// The date and time the request was started, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339),
// section 14.29.
TimeStarted *common.SDKTime `mandatory:"false" json:"timeStarted"`
// The date and time the object was finished, as described in RFC 3339 (https://tools.ietf.org/rfc/rfc3339).
TimeFinished *common.SDKTime `mandatory:"false" json:"timeFinished"`
}
func (m WorkRequestSummary) String() string
func (m WorkRequestSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly