1. Packages
  2. Akeyless Provider
  3. API Docs
  4. GatewayLogForwardingAwsS3
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

akeyless.GatewayLogForwardingAwsS3

Explore with Pulumi AI

akeyless logo
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community

    Log Forwarding config for aws-s3

    Create GatewayLogForwardingAwsS3 Resource

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

    Constructor syntax

    new GatewayLogForwardingAwsS3(name: string, args?: GatewayLogForwardingAwsS3Args, opts?: CustomResourceOptions);
    @overload
    def GatewayLogForwardingAwsS3(resource_name: str,
                                  args: Optional[GatewayLogForwardingAwsS3Args] = None,
                                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayLogForwardingAwsS3(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_log_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 NewGatewayLogForwardingAwsS3(ctx *Context, name string, args *GatewayLogForwardingAwsS3Args, opts ...ResourceOption) (*GatewayLogForwardingAwsS3, error)
    public GatewayLogForwardingAwsS3(string name, GatewayLogForwardingAwsS3Args? args = null, CustomResourceOptions? opts = null)
    public GatewayLogForwardingAwsS3(String name, GatewayLogForwardingAwsS3Args args)
    public GatewayLogForwardingAwsS3(String name, GatewayLogForwardingAwsS3Args args, CustomResourceOptions options)
    
    type: akeyless:GatewayLogForwardingAwsS3
    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 GatewayLogForwardingAwsS3Args
    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 GatewayLogForwardingAwsS3Args
    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 GatewayLogForwardingAwsS3Args
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayLogForwardingAwsS3Args
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayLogForwardingAwsS3Args
    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 gatewayLogForwardingAwsS3Resource = new Akeyless.GatewayLogForwardingAwsS3("gatewayLogForwardingAwsS3Resource", new()
    {
        AccessId = "string",
        AccessKey = "string",
        AuthType = "string",
        BucketName = "string",
        Enable = "string",
        GatewayLogForwardingAwsS3Id = "string",
        LogFolder = "string",
        OutputFormat = "string",
        PullInterval = "string",
        Region = "string",
        RoleArn = "string",
    });
    
    example, err := akeyless.NewGatewayLogForwardingAwsS3(ctx, "gatewayLogForwardingAwsS3Resource", &akeyless.GatewayLogForwardingAwsS3Args{
    	AccessId:                    pulumi.String("string"),
    	AccessKey:                   pulumi.String("string"),
    	AuthType:                    pulumi.String("string"),
    	BucketName:                  pulumi.String("string"),
    	Enable:                      pulumi.String("string"),
    	GatewayLogForwardingAwsS3Id: pulumi.String("string"),
    	LogFolder:                   pulumi.String("string"),
    	OutputFormat:                pulumi.String("string"),
    	PullInterval:                pulumi.String("string"),
    	Region:                      pulumi.String("string"),
    	RoleArn:                     pulumi.String("string"),
    })
    
    var gatewayLogForwardingAwsS3Resource = new GatewayLogForwardingAwsS3("gatewayLogForwardingAwsS3Resource", GatewayLogForwardingAwsS3Args.builder()
        .accessId("string")
        .accessKey("string")
        .authType("string")
        .bucketName("string")
        .enable("string")
        .gatewayLogForwardingAwsS3Id("string")
        .logFolder("string")
        .outputFormat("string")
        .pullInterval("string")
        .region("string")
        .roleArn("string")
        .build());
    
    gateway_log_forwarding_aws_s3_resource = akeyless.GatewayLogForwardingAwsS3("gatewayLogForwardingAwsS3Resource",
        access_id="string",
        access_key="string",
        auth_type="string",
        bucket_name="string",
        enable="string",
        gateway_log_forwarding_aws_s3_id="string",
        log_folder="string",
        output_format="string",
        pull_interval="string",
        region="string",
        role_arn="string")
    
    const gatewayLogForwardingAwsS3Resource = new akeyless.GatewayLogForwardingAwsS3("gatewayLogForwardingAwsS3Resource", {
        accessId: "string",
        accessKey: "string",
        authType: "string",
        bucketName: "string",
        enable: "string",
        gatewayLogForwardingAwsS3Id: "string",
        logFolder: "string",
        outputFormat: "string",
        pullInterval: "string",
        region: "string",
        roleArn: "string",
    });
    
    type: akeyless:GatewayLogForwardingAwsS3
    properties:
        accessId: string
        accessKey: string
        authType: string
        bucketName: string
        enable: string
        gatewayLogForwardingAwsS3Id: string
        logFolder: string
        outputFormat: string
        pullInterval: string
        region: string
        roleArn: string
    

    GatewayLogForwardingAwsS3 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 GatewayLogForwardingAwsS3 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]
    GatewayLogForwardingAwsS3Id 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]
    GatewayLogForwardingAwsS3Id 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]
    gatewayLogForwardingAwsS3Id 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]
    gatewayLogForwardingAwsS3Id 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_log_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]
    gatewayLogForwardingAwsS3Id 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 GatewayLogForwardingAwsS3 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 GatewayLogForwardingAwsS3 Resource

    Get an existing GatewayLogForwardingAwsS3 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?: GatewayLogForwardingAwsS3State, opts?: CustomResourceOptions): GatewayLogForwardingAwsS3
    @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_log_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) -> GatewayLogForwardingAwsS3
    func GetGatewayLogForwardingAwsS3(ctx *Context, name string, id IDInput, state *GatewayLogForwardingAwsS3State, opts ...ResourceOption) (*GatewayLogForwardingAwsS3, error)
    public static GatewayLogForwardingAwsS3 Get(string name, Input<string> id, GatewayLogForwardingAwsS3State? state, CustomResourceOptions? opts = null)
    public static GatewayLogForwardingAwsS3 get(String name, Output<String> id, GatewayLogForwardingAwsS3State state, CustomResourceOptions options)
    resources:  _:    type: akeyless:GatewayLogForwardingAwsS3    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]
    GatewayLogForwardingAwsS3Id 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]
    GatewayLogForwardingAwsS3Id 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]
    gatewayLogForwardingAwsS3Id 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]
    gatewayLogForwardingAwsS3Id 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_log_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]
    gatewayLogForwardingAwsS3Id 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

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless logo
    akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community