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

akeyless.GatewayAllowedAccess

Explore with Pulumi AI

Create gateway allowed access

Create GatewayAllowedAccess Resource

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

Constructor syntax

new GatewayAllowedAccess(name: string, args: GatewayAllowedAccessArgs, opts?: CustomResourceOptions);
@overload
def GatewayAllowedAccess(resource_name: str,
                         args: GatewayAllowedAccessArgs,
                         opts: Optional[ResourceOptions] = None)

@overload
def GatewayAllowedAccess(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         access_id: Optional[str] = None,
                         description: Optional[str] = None,
                         gateway_allowed_access_id: Optional[str] = None,
                         name: Optional[str] = None,
                         permissions: Optional[str] = None,
                         sub_claims: Optional[Mapping[str, str]] = None)
func NewGatewayAllowedAccess(ctx *Context, name string, args GatewayAllowedAccessArgs, opts ...ResourceOption) (*GatewayAllowedAccess, error)
public GatewayAllowedAccess(string name, GatewayAllowedAccessArgs args, CustomResourceOptions? opts = null)
public GatewayAllowedAccess(String name, GatewayAllowedAccessArgs args)
public GatewayAllowedAccess(String name, GatewayAllowedAccessArgs args, CustomResourceOptions options)
type: akeyless:GatewayAllowedAccess
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. GatewayAllowedAccessArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. GatewayAllowedAccessArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayAllowedAccessArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. GatewayAllowedAccessArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. GatewayAllowedAccessArgs
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 gatewayAllowedAccessResource = new Akeyless.GatewayAllowedAccess("gatewayAllowedAccessResource", new()
{
    AccessId = "string",
    Description = "string",
    GatewayAllowedAccessId = "string",
    Name = "string",
    Permissions = "string",
    SubClaims = 
    {
        { "string", "string" },
    },
});
Copy
example, err := akeyless.NewGatewayAllowedAccess(ctx, "gatewayAllowedAccessResource", &akeyless.GatewayAllowedAccessArgs{
AccessId: pulumi.String("string"),
Description: pulumi.String("string"),
GatewayAllowedAccessId: pulumi.String("string"),
Name: pulumi.String("string"),
Permissions: pulumi.String("string"),
SubClaims: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
Copy
var gatewayAllowedAccessResource = new GatewayAllowedAccess("gatewayAllowedAccessResource", GatewayAllowedAccessArgs.builder()
    .accessId("string")
    .description("string")
    .gatewayAllowedAccessId("string")
    .name("string")
    .permissions("string")
    .subClaims(Map.of("string", "string"))
    .build());
Copy
gateway_allowed_access_resource = akeyless.GatewayAllowedAccess("gatewayAllowedAccessResource",
    access_id="string",
    description="string",
    gateway_allowed_access_id="string",
    name="string",
    permissions="string",
    sub_claims={
        "string": "string",
    })
Copy
const gatewayAllowedAccessResource = new akeyless.GatewayAllowedAccess("gatewayAllowedAccessResource", {
    accessId: "string",
    description: "string",
    gatewayAllowedAccessId: "string",
    name: "string",
    permissions: "string",
    subClaims: {
        string: "string",
    },
});
Copy
type: akeyless:GatewayAllowedAccess
properties:
    accessId: string
    description: string
    gatewayAllowedAccessId: string
    name: string
    permissions: string
    subClaims:
        string: string
Copy

GatewayAllowedAccess 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 GatewayAllowedAccess resource accepts the following input properties:

AccessId This property is required. string
The access id to be attached to this allowed access
Description string
Allowed access description
GatewayAllowedAccessId string
The ID of this resource.
Name string
Allowed access name
Permissions string
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
SubClaims Dictionary<string, string>
key/val of sub claims, e.g group=admins,developers
AccessId This property is required. string
The access id to be attached to this allowed access
Description string
Allowed access description
GatewayAllowedAccessId string
The ID of this resource.
Name string
Allowed access name
Permissions string
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
SubClaims map[string]string
key/val of sub claims, e.g group=admins,developers
accessId This property is required. String
The access id to be attached to this allowed access
description String
Allowed access description
gatewayAllowedAccessId String
The ID of this resource.
name String
Allowed access name
permissions String
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
subClaims Map<String,String>
key/val of sub claims, e.g group=admins,developers
accessId This property is required. string
The access id to be attached to this allowed access
description string
Allowed access description
gatewayAllowedAccessId string
The ID of this resource.
name string
Allowed access name
permissions string
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
subClaims {[key: string]: string}
key/val of sub claims, e.g group=admins,developers
access_id This property is required. str
The access id to be attached to this allowed access
description str
Allowed access description
gateway_allowed_access_id str
The ID of this resource.
name str
Allowed access name
permissions str
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
sub_claims Mapping[str, str]
key/val of sub claims, e.g group=admins,developers
accessId This property is required. String
The access id to be attached to this allowed access
description String
Allowed access description
gatewayAllowedAccessId String
The ID of this resource.
name String
Allowed access name
permissions String
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
subClaims Map<String>
key/val of sub claims, e.g group=admins,developers

Outputs

All input properties are implicitly available as output properties. Additionally, the GatewayAllowedAccess 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 GatewayAllowedAccess Resource

Get an existing GatewayAllowedAccess 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?: GatewayAllowedAccessState, opts?: CustomResourceOptions): GatewayAllowedAccess
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_id: Optional[str] = None,
        description: Optional[str] = None,
        gateway_allowed_access_id: Optional[str] = None,
        name: Optional[str] = None,
        permissions: Optional[str] = None,
        sub_claims: Optional[Mapping[str, str]] = None) -> GatewayAllowedAccess
func GetGatewayAllowedAccess(ctx *Context, name string, id IDInput, state *GatewayAllowedAccessState, opts ...ResourceOption) (*GatewayAllowedAccess, error)
public static GatewayAllowedAccess Get(string name, Input<string> id, GatewayAllowedAccessState? state, CustomResourceOptions? opts = null)
public static GatewayAllowedAccess get(String name, Output<String> id, GatewayAllowedAccessState state, CustomResourceOptions options)
resources:  _:    type: akeyless:GatewayAllowedAccess    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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
The access id to be attached to this allowed access
Description string
Allowed access description
GatewayAllowedAccessId string
The ID of this resource.
Name string
Allowed access name
Permissions string
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
SubClaims Dictionary<string, string>
key/val of sub claims, e.g group=admins,developers
AccessId string
The access id to be attached to this allowed access
Description string
Allowed access description
GatewayAllowedAccessId string
The ID of this resource.
Name string
Allowed access name
Permissions string
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
SubClaims map[string]string
key/val of sub claims, e.g group=admins,developers
accessId String
The access id to be attached to this allowed access
description String
Allowed access description
gatewayAllowedAccessId String
The ID of this resource.
name String
Allowed access name
permissions String
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
subClaims Map<String,String>
key/val of sub claims, e.g group=admins,developers
accessId string
The access id to be attached to this allowed access
description string
Allowed access description
gatewayAllowedAccessId string
The ID of this resource.
name string
Allowed access name
permissions string
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
subClaims {[key: string]: string}
key/val of sub claims, e.g group=admins,developers
access_id str
The access id to be attached to this allowed access
description str
Allowed access description
gateway_allowed_access_id str
The ID of this resource.
name str
Allowed access name
permissions str
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
sub_claims Mapping[str, str]
key/val of sub claims, e.g group=admins,developers
accessId String
The access id to be attached to this allowed access
description String
Allowed access description
gatewayAllowedAccessId String
The ID of this resource.
name String
Allowed access name
permissions String
Comma-seperated list of permissions for this allowed access. Available permissions: [defaults,targets,classickeys,automaticmigration,ldapauth,dynamicsecret,k8sauth,logforwarding,zeroknowledgeencryption,rotatedsecret,caching,eventforwarding,admin,kmip,general]
subClaims Map<String>
key/val of sub claims, e.g group=admins,developers

Package Details

Repository
akeyless akeyless-community/terraform-provider-akeyless
License
Notes
This Pulumi package is based on the akeyless Terraform Provider.