akeyless.GatewayRemoteAccessSessionForwardingAwsS3

akeyless 2.0.1, Apr 27 26

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Viewing docs for akeyless 2.0.1
published on Monday, Apr 27, 2026 by akeyless-community

akeyless-community/terraform-provider-akeyless

Create GatewayRemoteAccessSessionForwardingAwsS3 Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new GatewayRemoteAccessSessionForwardingAwsS3(name: string, args?: GatewayRemoteAccessSessionForwardingAwsS3Args, opts?: CustomResourceOptions);

@overload
def GatewayRemoteAccessSessionForwardingAwsS3(resource_name: str,
                                              args: Optional[GatewayRemoteAccessSessionForwardingAwsS3Args] = None,
                                              opts: Optional[ResourceOptions] = None)

@overload
def GatewayRemoteAccessSessionForwardingAwsS3(resource_name: str,
                                              opts: Optional[ResourceOptions] = None,
                                              access_id: Optional[str] = None,
                                              access_key: Optional[str] = None,
                                              auth_type: Optional[str] = None,
                                              bucket_name: Optional[str] = None,
                                              enable: Optional[str] = None,
                                              gateway_remote_access_session_forwarding_aws_s3_id: Optional[str] = None,
                                              log_folder: Optional[str] = None,
                                              output_format: Optional[str] = None,
                                              pull_interval: Optional[str] = None,
                                              region: Optional[str] = None,
                                              role_arn: Optional[str] = None)

func NewGatewayRemoteAccessSessionForwardingAwsS3(ctx *Context, name string, args *GatewayRemoteAccessSessionForwardingAwsS3Args, opts ...ResourceOption) (*GatewayRemoteAccessSessionForwardingAwsS3, error)

public GatewayRemoteAccessSessionForwardingAwsS3(string name, GatewayRemoteAccessSessionForwardingAwsS3Args? args = null, CustomResourceOptions? opts = null)

public GatewayRemoteAccessSessionForwardingAwsS3(String name, GatewayRemoteAccessSessionForwardingAwsS3Args args)
public GatewayRemoteAccessSessionForwardingAwsS3(String name, GatewayRemoteAccessSessionForwardingAwsS3Args args, CustomResourceOptions options)

type: akeyless:GatewayRemoteAccessSessionForwardingAwsS3
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name string: The unique name of the resource.
args GatewayRemoteAccessSessionForwardingAwsS3Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args GatewayRemoteAccessSessionForwardingAwsS3Args: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args GatewayRemoteAccessSessionForwardingAwsS3Args: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GatewayRemoteAccessSessionForwardingAwsS3Args: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GatewayRemoteAccessSessionForwardingAwsS3Args: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var gatewayRemoteAccessSessionForwardingAwsS3Resource = new Akeyless.GatewayRemoteAccessSessionForwardingAwsS3("gatewayRemoteAccessSessionForwardingAwsS3Resource", new()
{
    AccessId = "string",
    AccessKey = "string",
    AuthType = "string",
    BucketName = "string",
    Enable = "string",
    GatewayRemoteAccessSessionForwardingAwsS3Id = "string",
    LogFolder = "string",
    OutputFormat = "string",
    PullInterval = "string",
    Region = "string",
    RoleArn = "string",
});

example, err := akeyless.NewGatewayRemoteAccessSessionForwardingAwsS3(ctx, "gatewayRemoteAccessSessionForwardingAwsS3Resource", &akeyless.GatewayRemoteAccessSessionForwardingAwsS3Args{
	AccessId:   pulumi.String("string"),
	AccessKey:  pulumi.String("string"),
	AuthType:   pulumi.String("string"),
	BucketName: pulumi.String("string"),
	Enable:     pulumi.String("string"),
	GatewayRemoteAccessSessionForwardingAwsS3Id: pulumi.String("string"),
	LogFolder:    pulumi.String("string"),
	OutputFormat: pulumi.String("string"),
	PullInterval: pulumi.String("string"),
	Region:       pulumi.String("string"),
	RoleArn:      pulumi.String("string"),
})

var gatewayRemoteAccessSessionForwardingAwsS3Resource = new GatewayRemoteAccessSessionForwardingAwsS3("gatewayRemoteAccessSessionForwardingAwsS3Resource", GatewayRemoteAccessSessionForwardingAwsS3Args.builder()
    .accessId("string")
    .accessKey("string")
    .authType("string")
    .bucketName("string")
    .enable("string")
    .gatewayRemoteAccessSessionForwardingAwsS3Id("string")
    .logFolder("string")
    .outputFormat("string")
    .pullInterval("string")
    .region("string")
    .roleArn("string")
    .build());

gateway_remote_access_session_forwarding_aws_s3_resource = akeyless.GatewayRemoteAccessSessionForwardingAwsS3("gatewayRemoteAccessSessionForwardingAwsS3Resource",
    access_id="string",
    access_key="string",
    auth_type="string",
    bucket_name="string",
    enable="string",
    gateway_remote_access_session_forwarding_aws_s3_id="string",
    log_folder="string",
    output_format="string",
    pull_interval="string",
    region="string",
    role_arn="string")

const gatewayRemoteAccessSessionForwardingAwsS3Resource = new akeyless.GatewayRemoteAccessSessionForwardingAwsS3("gatewayRemoteAccessSessionForwardingAwsS3Resource", {
    accessId: "string",
    accessKey: "string",
    authType: "string",
    bucketName: "string",
    enable: "string",
    gatewayRemoteAccessSessionForwardingAwsS3Id: "string",
    logFolder: "string",
    outputFormat: "string",
    pullInterval: "string",
    region: "string",
    roleArn: "string",
});

type: akeyless:GatewayRemoteAccessSessionForwardingAwsS3
properties:
    accessId: string
    accessKey: string
    authType: string
    bucketName: string
    enable: string
    gatewayRemoteAccessSessionForwardingAwsS3Id: string
    logFolder: string
    outputFormat: string
    pullInterval: string
    region: string
    roleArn: string

GatewayRemoteAccessSessionForwardingAwsS3 Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GatewayRemoteAccessSessionForwardingAwsS3 resource accepts the following input properties:

AccessId string: AWS access id relevant for access_key auth-type
AccessKey string: AWS access key relevant for access_key auth-type
AuthType string: AWS auth type [accesskey/cloudid/assume_role]
BucketName string: AWS S3 bucket name
Enable string: Enable Log Forwarding [true/false]
GatewayRemoteAccessSessionForwardingAwsS3Id string: The ID of this resource.
LogFolder string: AWS S3 destination folder for logs
OutputFormat string: Logs format [text/json]
PullInterval string: Pull interval in seconds
Region string: AWS region
RoleArn string: AWS role arn relevant for assume_role auth-type

AccessId string: AWS access id relevant for access_key auth-type
AccessKey string: AWS access key relevant for access_key auth-type
AuthType string: AWS auth type [accesskey/cloudid/assume_role]
BucketName string: AWS S3 bucket name
Enable string: Enable Log Forwarding [true/false]
GatewayRemoteAccessSessionForwardingAwsS3Id string: The ID of this resource.
LogFolder string: AWS S3 destination folder for logs
OutputFormat string: Logs format [text/json]
PullInterval string: Pull interval in seconds
Region string: AWS region
RoleArn string: AWS role arn relevant for assume_role auth-type

accessId String: AWS access id relevant for access_key auth-type
accessKey String: AWS access key relevant for access_key auth-type
authType String: AWS auth type [accesskey/cloudid/assume_role]
bucketName String: AWS S3 bucket name
enable String: Enable Log Forwarding [true/false]
gatewayRemoteAccessSessionForwardingAwsS3Id String: The ID of this resource.
logFolder String: AWS S3 destination folder for logs
outputFormat String: Logs format [text/json]
pullInterval String: Pull interval in seconds
region String: AWS region
roleArn String: AWS role arn relevant for assume_role auth-type

accessId string: AWS access id relevant for access_key auth-type
accessKey string: AWS access key relevant for access_key auth-type
authType string: AWS auth type [accesskey/cloudid/assume_role]
bucketName string: AWS S3 bucket name
enable string: Enable Log Forwarding [true/false]
gatewayRemoteAccessSessionForwardingAwsS3Id string: The ID of this resource.
logFolder string: AWS S3 destination folder for logs
outputFormat string: Logs format [text/json]
pullInterval string: Pull interval in seconds
region string: AWS region
roleArn string: AWS role arn relevant for assume_role auth-type

access_id str: AWS access id relevant for access_key auth-type
access_key str: AWS access key relevant for access_key auth-type
auth_type str: AWS auth type [accesskey/cloudid/assume_role]
bucket_name str: AWS S3 bucket name
enable str: Enable Log Forwarding [true/false]
gateway_remote_access_session_forwarding_aws_s3_id str: The ID of this resource.
log_folder str: AWS S3 destination folder for logs
output_format str: Logs format [text/json]
pull_interval str: Pull interval in seconds
region str: AWS region
role_arn str: AWS role arn relevant for assume_role auth-type

accessId String: AWS access id relevant for access_key auth-type
accessKey String: AWS access key relevant for access_key auth-type
authType String: AWS auth type [accesskey/cloudid/assume_role]
bucketName String: AWS S3 bucket name
enable String: Enable Log Forwarding [true/false]
gatewayRemoteAccessSessionForwardingAwsS3Id String: The ID of this resource.
logFolder String: AWS S3 destination folder for logs
outputFormat String: Logs format [text/json]
pullInterval String: Pull interval in seconds
region String: AWS region
roleArn String: AWS role arn relevant for assume_role auth-type

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayRemoteAccessSessionForwardingAwsS3 resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

id String: The provider-assigned unique ID for this managed resource.

Look up Existing GatewayRemoteAccessSessionForwardingAwsS3 Resource

Get an existing GatewayRemoteAccessSessionForwardingAwsS3 resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: GatewayRemoteAccessSessionForwardingAwsS3State, opts?: CustomResourceOptions): GatewayRemoteAccessSessionForwardingAwsS3

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_id: Optional[str] = None,
        access_key: Optional[str] = None,
        auth_type: Optional[str] = None,
        bucket_name: Optional[str] = None,
        enable: Optional[str] = None,
        gateway_remote_access_session_forwarding_aws_s3_id: Optional[str] = None,
        log_folder: Optional[str] = None,
        output_format: Optional[str] = None,
        pull_interval: Optional[str] = None,
        region: Optional[str] = None,
        role_arn: Optional[str] = None) -> GatewayRemoteAccessSessionForwardingAwsS3

func GetGatewayRemoteAccessSessionForwardingAwsS3(ctx *Context, name string, id IDInput, state *GatewayRemoteAccessSessionForwardingAwsS3State, opts ...ResourceOption) (*GatewayRemoteAccessSessionForwardingAwsS3, error)

public static GatewayRemoteAccessSessionForwardingAwsS3 Get(string name, Input<string> id, GatewayRemoteAccessSessionForwardingAwsS3State? state, CustomResourceOptions? opts = null)

public static GatewayRemoteAccessSessionForwardingAwsS3 get(String name, Output<String> id, GatewayRemoteAccessSessionForwardingAwsS3State state, CustomResourceOptions options)

resources:  _:    type: akeyless:GatewayRemoteAccessSessionForwardingAwsS3    get:      id: ${id}

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

AccessId string: AWS access id relevant for access_key auth-type
AccessKey string: AWS access key relevant for access_key auth-type
AuthType string: AWS auth type [accesskey/cloudid/assume_role]
BucketName string: AWS S3 bucket name
Enable string: Enable Log Forwarding [true/false]
GatewayRemoteAccessSessionForwardingAwsS3Id string: The ID of this resource.
LogFolder string: AWS S3 destination folder for logs
OutputFormat string: Logs format [text/json]
PullInterval string: Pull interval in seconds
Region string: AWS region
RoleArn string: AWS role arn relevant for assume_role auth-type

AccessId string: AWS access id relevant for access_key auth-type
AccessKey string: AWS access key relevant for access_key auth-type
AuthType string: AWS auth type [accesskey/cloudid/assume_role]
BucketName string: AWS S3 bucket name
Enable string: Enable Log Forwarding [true/false]
GatewayRemoteAccessSessionForwardingAwsS3Id string: The ID of this resource.
LogFolder string: AWS S3 destination folder for logs
OutputFormat string: Logs format [text/json]
PullInterval string: Pull interval in seconds
Region string: AWS region
RoleArn string: AWS role arn relevant for assume_role auth-type

accessId String: AWS access id relevant for access_key auth-type
accessKey String: AWS access key relevant for access_key auth-type
authType String: AWS auth type [accesskey/cloudid/assume_role]
bucketName String: AWS S3 bucket name
enable String: Enable Log Forwarding [true/false]
gatewayRemoteAccessSessionForwardingAwsS3Id String: The ID of this resource.
logFolder String: AWS S3 destination folder for logs
outputFormat String: Logs format [text/json]
pullInterval String: Pull interval in seconds
region String: AWS region
roleArn String: AWS role arn relevant for assume_role auth-type

accessId string: AWS access id relevant for access_key auth-type
accessKey string: AWS access key relevant for access_key auth-type
authType string: AWS auth type [accesskey/cloudid/assume_role]
bucketName string: AWS S3 bucket name
enable string: Enable Log Forwarding [true/false]
gatewayRemoteAccessSessionForwardingAwsS3Id string: The ID of this resource.
logFolder string: AWS S3 destination folder for logs
outputFormat string: Logs format [text/json]
pullInterval string: Pull interval in seconds
region string: AWS region
roleArn string: AWS role arn relevant for assume_role auth-type

access_id str: AWS access id relevant for access_key auth-type
access_key str: AWS access key relevant for access_key auth-type
auth_type str: AWS auth type [accesskey/cloudid/assume_role]
bucket_name str: AWS S3 bucket name
enable str: Enable Log Forwarding [true/false]
gateway_remote_access_session_forwarding_aws_s3_id str: The ID of this resource.
log_folder str: AWS S3 destination folder for logs
output_format str: Logs format [text/json]
pull_interval str: Pull interval in seconds
region str: AWS region
role_arn str: AWS role arn relevant for assume_role auth-type

accessId String: AWS access id relevant for access_key auth-type
accessKey String: AWS access key relevant for access_key auth-type
authType String: AWS auth type [accesskey/cloudid/assume_role]
bucketName String: AWS S3 bucket name
enable String: Enable Log Forwarding [true/false]
gatewayRemoteAccessSessionForwardingAwsS3Id String: The ID of this resource.
logFolder String: AWS S3 destination folder for logs
outputFormat String: Logs format [text/json]
pullInterval String: Pull interval in seconds
region String: AWS region
roleArn String: AWS role arn relevant for assume_role auth-type