Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Akeyless Provider
  3. API Docs
  4. GatewayDefaults
akeyless 1.9.0 published on Monday, Apr 14, 2025 by akeyless-community
akeyless-community/terraform-provider-akeyless

akeyless.GatewayDefaults

Explore with Pulumi AI

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

    Defaults settings

    Create GatewayDefaults Resource

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

    Constructor syntax

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

@overload
def GatewayDefaults(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    cert_access_id: Optional[str] = None,
                    event_on_status_change: Optional[str] = None,
                    gateway_defaults_id: Optional[str] = None,
                    key: Optional[str] = None,
                    oidc_access_id: Optional[str] = None,
                    saml_access_id: Optional[str] = None)
    func NewGatewayDefaults(ctx *Context, name string, args *GatewayDefaultsArgs, opts ...ResourceOption) (*GatewayDefaults, error)
    public GatewayDefaults(string name, GatewayDefaultsArgs? args = null, CustomResourceOptions? opts = null)
    public GatewayDefaults(String name, GatewayDefaultsArgs args)
public GatewayDefaults(String name, GatewayDefaultsArgs args, CustomResourceOptions options)

    type: akeyless:GatewayDefaults
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 GatewayDefaultsArgs
    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 GatewayDefaultsArgs
    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 GatewayDefaultsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayDefaultsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayDefaultsArgs
    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 gatewayDefaultsResource = new Akeyless.GatewayDefaults("gatewayDefaultsResource", new()
{
    CertAccessId = "string",
    EventOnStatusChange = "string",
    GatewayDefaultsId = "string",
    Key = "string",
    OidcAccessId = "string",
    SamlAccessId = "string",
});

    example, err := akeyless.NewGatewayDefaults(ctx, "gatewayDefaultsResource", &akeyless.GatewayDefaultsArgs{
	CertAccessId:        pulumi.String("string"),
	EventOnStatusChange: pulumi.String("string"),
	GatewayDefaultsId:   pulumi.String("string"),
	Key:                 pulumi.String("string"),
	OidcAccessId:        pulumi.String("string"),
	SamlAccessId:        pulumi.String("string"),
})

    var gatewayDefaultsResource = new GatewayDefaults("gatewayDefaultsResource", GatewayDefaultsArgs.builder()
    .certAccessId("string")
    .eventOnStatusChange("string")
    .gatewayDefaultsId("string")
    .key("string")
    .oidcAccessId("string")
    .samlAccessId("string")
    .build());

    gateway_defaults_resource = akeyless.GatewayDefaults("gatewayDefaultsResource",
    cert_access_id="string",
    event_on_status_change="string",
    gateway_defaults_id="string",
    key="string",
    oidc_access_id="string",
    saml_access_id="string")

    const gatewayDefaultsResource = new akeyless.GatewayDefaults("gatewayDefaultsResource", {
    certAccessId: "string",
    eventOnStatusChange: "string",
    gatewayDefaultsId: "string",
    key: "string",
    oidcAccessId: "string",
    samlAccessId: "string",
});

    type: akeyless:GatewayDefaults
properties:
    certAccessId: string
    eventOnStatusChange: string
    gatewayDefaultsId: string
    key: string
    oidcAccessId: string
    samlAccessId: string

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

    CertAccessId string
    Default Certificate access-id for UI login
    EventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    GatewayDefaultsId string
    The ID of this resource.
    Key string
    The name of the gateway default encryption key
    OidcAccessId string
    Default OIDC access-id for UI login
    SamlAccessId string
    Default SAML access-id for UI login
    CertAccessId string
    Default Certificate access-id for UI login
    EventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    GatewayDefaultsId string
    The ID of this resource.
    Key string
    The name of the gateway default encryption key
    OidcAccessId string
    Default OIDC access-id for UI login
    SamlAccessId string
    Default SAML access-id for UI login
    certAccessId String
    Default Certificate access-id for UI login
    eventOnStatusChange String
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId String
    The ID of this resource.
    key String
    The name of the gateway default encryption key
    oidcAccessId String
    Default OIDC access-id for UI login
    samlAccessId String
    Default SAML access-id for UI login
    certAccessId string
    Default Certificate access-id for UI login
    eventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId string
    The ID of this resource.
    key string
    The name of the gateway default encryption key
    oidcAccessId string
    Default OIDC access-id for UI login
    samlAccessId string
    Default SAML access-id for UI login
    cert_access_id str
    Default Certificate access-id for UI login
    event_on_status_change str
    Trigger an event when Gateway status is changed [true/false]
    gateway_defaults_id str
    The ID of this resource.
    key str
    The name of the gateway default encryption key
    oidc_access_id str
    Default OIDC access-id for UI login
    saml_access_id str
    Default SAML access-id for UI login
    certAccessId String
    Default Certificate access-id for UI login
    eventOnStatusChange String
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId String
    The ID of this resource.
    key String
    The name of the gateway default encryption key
    oidcAccessId String
    Default OIDC access-id for UI login
    samlAccessId String
    Default SAML access-id for UI login

    Outputs

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

    Get an existing GatewayDefaults 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?: GatewayDefaultsState, opts?: CustomResourceOptions): GatewayDefaults
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        cert_access_id: Optional[str] = None,
        event_on_status_change: Optional[str] = None,
        gateway_defaults_id: Optional[str] = None,
        key: Optional[str] = None,
        oidc_access_id: Optional[str] = None,
        saml_access_id: Optional[str] = None) -> GatewayDefaults
    func GetGatewayDefaults(ctx *Context, name string, id IDInput, state *GatewayDefaultsState, opts ...ResourceOption) (*GatewayDefaults, error)
    public static GatewayDefaults Get(string name, Input<string> id, GatewayDefaultsState? state, CustomResourceOptions? opts = null)
    public static GatewayDefaults get(String name, Output<String> id, GatewayDefaultsState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:GatewayDefaults    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:
    CertAccessId string
    Default Certificate access-id for UI login
    EventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    GatewayDefaultsId string
    The ID of this resource.
    Key string
    The name of the gateway default encryption key
    OidcAccessId string
    Default OIDC access-id for UI login
    SamlAccessId string
    Default SAML access-id for UI login
    CertAccessId string
    Default Certificate access-id for UI login
    EventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    GatewayDefaultsId string
    The ID of this resource.
    Key string
    The name of the gateway default encryption key
    OidcAccessId string
    Default OIDC access-id for UI login
    SamlAccessId string
    Default SAML access-id for UI login
    certAccessId String
    Default Certificate access-id for UI login
    eventOnStatusChange String
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId String
    The ID of this resource.
    key String
    The name of the gateway default encryption key
    oidcAccessId String
    Default OIDC access-id for UI login
    samlAccessId String
    Default SAML access-id for UI login
    certAccessId string
    Default Certificate access-id for UI login
    eventOnStatusChange string
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId string
    The ID of this resource.
    key string
    The name of the gateway default encryption key
    oidcAccessId string
    Default OIDC access-id for UI login
    samlAccessId string
    Default SAML access-id for UI login
    cert_access_id str
    Default Certificate access-id for UI login
    event_on_status_change str
    Trigger an event when Gateway status is changed [true/false]
    gateway_defaults_id str
    The ID of this resource.
    key str
    The name of the gateway default encryption key
    oidc_access_id str
    Default OIDC access-id for UI login
    saml_access_id str
    Default SAML access-id for UI login
    certAccessId String
    Default Certificate access-id for UI login
    eventOnStatusChange String
    Trigger an event when Gateway status is changed [true/false]
    gatewayDefaultsId String
    The ID of this resource.
    key String
    The name of the gateway default encryption key
    oidcAccessId String
    Default OIDC access-id for UI login
    samlAccessId String
    Default SAML access-id for UI login

    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
    akeyless-community/terraform-provider-akeyless