1. Registry
  2. Packages
  3. Akeyless Provider
  4. API Docs
  5. GatewayMigrationGcp
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community
akeyless
Viewing docs for akeyless 2.1.0
published on Thursday, Nov 19, 2026 by akeyless-community

    GCP Migration resource

    Create GatewayMigrationGcp Resource

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

    Constructor syntax

    new GatewayMigrationGcp(name: string, args: GatewayMigrationGcpArgs, opts?: CustomResourceOptions);
    @overload
    def GatewayMigrationGcp(resource_name: str,
                            args: GatewayMigrationGcpArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def GatewayMigrationGcp(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            target_location: Optional[str] = None,
                            gateway_migration_gcp_id: Optional[str] = None,
                            gcp_key: Optional[str] = None,
                            name: Optional[str] = None,
                            protection_key: Optional[str] = None,
                            retry: Optional[GatewayMigrationGcpRetryArgs] = None)
    func NewGatewayMigrationGcp(ctx *Context, name string, args GatewayMigrationGcpArgs, opts ...ResourceOption) (*GatewayMigrationGcp, error)
    public GatewayMigrationGcp(string name, GatewayMigrationGcpArgs args, CustomResourceOptions? opts = null)
    public GatewayMigrationGcp(String name, GatewayMigrationGcpArgs args)
    public GatewayMigrationGcp(String name, GatewayMigrationGcpArgs args, CustomResourceOptions options)
    
    type: akeyless:GatewayMigrationGcp
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "akeyless_gateway_migration_gcp" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args GatewayMigrationGcpArgs
    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 GatewayMigrationGcpArgs
    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 GatewayMigrationGcpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GatewayMigrationGcpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GatewayMigrationGcpArgs
    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 gatewayMigrationGcpResource = new Akeyless.GatewayMigrationGcp("gatewayMigrationGcpResource", new()
    {
        TargetLocation = "string",
        GatewayMigrationGcpId = "string",
        GcpKey = "string",
        Name = "string",
        ProtectionKey = "string",
        Retry = new Akeyless.Inputs.GatewayMigrationGcpRetryArgs
        {
            ErrorMessageRegexes = new[]
            {
                "string",
            },
            IntervalSeconds = 0.0,
            MaxIntervalSeconds = 0.0,
            MaxRetries = 0.0,
            RetryOnStatusCodes = new[]
            {
                0.0,
            },
        },
    });
    
    example, err := akeyless.NewGatewayMigrationGcp(ctx, "gatewayMigrationGcpResource", &akeyless.GatewayMigrationGcpArgs{
    	TargetLocation:        pulumi.String("string"),
    	GatewayMigrationGcpId: pulumi.String("string"),
    	GcpKey:                pulumi.String("string"),
    	Name:                  pulumi.String("string"),
    	ProtectionKey:         pulumi.String("string"),
    	Retry: &akeyless.GatewayMigrationGcpRetryArgs{
    		ErrorMessageRegexes: pulumi.StringArray{
    			pulumi.String("string"),
    		},
    		IntervalSeconds:    pulumi.Float64(0),
    		MaxIntervalSeconds: pulumi.Float64(0),
    		MaxRetries:         pulumi.Float64(0),
    		RetryOnStatusCodes: pulumi.Float64Array{
    			pulumi.Float64(0),
    		},
    	},
    })
    
    resource "akeyless_gateway_migration_gcp" "gatewayMigrationGcpResource" {
      lifecycle {
        create_before_destroy = true
      }
      target_location          = "string"
      gateway_migration_gcp_id = "string"
      gcp_key                  = "string"
      name                     = "string"
      protection_key           = "string"
      retry = {
        error_message_regexes = ["string"]
        interval_seconds      = 0
        max_interval_seconds  = 0
        max_retries           = 0
        retry_on_status_codes = [0]
      }
    }
    
    var gatewayMigrationGcpResource = new GatewayMigrationGcp("gatewayMigrationGcpResource", GatewayMigrationGcpArgs.builder()
        .targetLocation("string")
        .gatewayMigrationGcpId("string")
        .gcpKey("string")
        .name("string")
        .protectionKey("string")
        .retry(GatewayMigrationGcpRetryArgs.builder()
            .errorMessageRegexes("string")
            .intervalSeconds(0.0)
            .maxIntervalSeconds(0.0)
            .maxRetries(0.0)
            .retryOnStatusCodes(0.0)
            .build())
        .build());
    
    gateway_migration_gcp_resource = akeyless.GatewayMigrationGcp("gatewayMigrationGcpResource",
        target_location="string",
        gateway_migration_gcp_id="string",
        gcp_key="string",
        name="string",
        protection_key="string",
        retry={
            "error_message_regexes": ["string"],
            "interval_seconds": float(0),
            "max_interval_seconds": float(0),
            "max_retries": float(0),
            "retry_on_status_codes": [float(0)],
        })
    
    const gatewayMigrationGcpResource = new akeyless.GatewayMigrationGcp("gatewayMigrationGcpResource", {
        targetLocation: "string",
        gatewayMigrationGcpId: "string",
        gcpKey: "string",
        name: "string",
        protectionKey: "string",
        retry: {
            errorMessageRegexes: ["string"],
            intervalSeconds: 0,
            maxIntervalSeconds: 0,
            maxRetries: 0,
            retryOnStatusCodes: [0],
        },
    });
    
    type: akeyless:GatewayMigrationGcp
    properties:
        gatewayMigrationGcpId: string
        gcpKey: string
        name: string
        protectionKey: string
        retry:
            errorMessageRegexes:
                - string
            intervalSeconds: 0
            maxIntervalSeconds: 0
            maxRetries: 0
            retryOnStatusCodes:
                - 0
        targetLocation: string
    

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

    TargetLocation string
    Target location in Akeyless for imported secrets
    GatewayMigrationGcpId string
    The ID of this resource.
    GcpKey string
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    Name string
    Migration name
    ProtectionKey string
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    Retry GatewayMigrationGcpRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TargetLocation string
    Target location in Akeyless for imported secrets
    GatewayMigrationGcpId string
    The ID of this resource.
    GcpKey string
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    Name string
    Migration name
    ProtectionKey string
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    Retry GatewayMigrationGcpRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    target_location string
    Target location in Akeyless for imported secrets
    gateway_migration_gcp_id string
    The ID of this resource.
    gcp_key string
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    name string
    Migration name
    protection_key string
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetLocation String
    Target location in Akeyless for imported secrets
    gatewayMigrationGcpId String
    The ID of this resource.
    gcpKey String
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    name String
    Migration name
    protectionKey String
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    retry GatewayMigrationGcpRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetLocation string
    Target location in Akeyless for imported secrets
    gatewayMigrationGcpId string
    The ID of this resource.
    gcpKey string
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    name string
    Migration name
    protectionKey string
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    retry GatewayMigrationGcpRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    target_location str
    Target location in Akeyless for imported secrets
    gateway_migration_gcp_id str
    The ID of this resource.
    gcp_key str
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    name str
    Migration name
    protection_key str
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    retry GatewayMigrationGcpRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetLocation String
    Target location in Akeyless for imported secrets
    gatewayMigrationGcpId String
    The ID of this resource.
    gcpKey String
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    name String
    Migration name
    protectionKey String
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    MigrationId string
    Migration ID
    Id string
    The provider-assigned unique ID for this managed resource.
    MigrationId string
    Migration ID
    id string
    The provider-assigned unique ID for this managed resource.
    migration_id string
    Migration ID
    id String
    The provider-assigned unique ID for this managed resource.
    migrationId String
    Migration ID
    id string
    The provider-assigned unique ID for this managed resource.
    migrationId string
    Migration ID
    id str
    The provider-assigned unique ID for this managed resource.
    migration_id str
    Migration ID
    id String
    The provider-assigned unique ID for this managed resource.
    migrationId String
    Migration ID

    Look up Existing GatewayMigrationGcp Resource

    Get an existing GatewayMigrationGcp 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?: GatewayMigrationGcpState, opts?: CustomResourceOptions): GatewayMigrationGcp
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            gateway_migration_gcp_id: Optional[str] = None,
            gcp_key: Optional[str] = None,
            migration_id: Optional[str] = None,
            name: Optional[str] = None,
            protection_key: Optional[str] = None,
            retry: Optional[GatewayMigrationGcpRetryArgs] = None,
            target_location: Optional[str] = None) -> GatewayMigrationGcp
    func GetGatewayMigrationGcp(ctx *Context, name string, id IDInput, state *GatewayMigrationGcpState, opts ...ResourceOption) (*GatewayMigrationGcp, error)
    public static GatewayMigrationGcp Get(string name, Input<string> id, GatewayMigrationGcpState? state, CustomResourceOptions? opts = null)
    public static GatewayMigrationGcp get(String name, Output<String> id, GatewayMigrationGcpState state, CustomResourceOptions options)
    resources:  existingGatewayMigrationGcp:    type: akeyless:GatewayMigrationGcp    get:      id: ${id}
    import {
      to = akeyless_gateway_migration_gcp.example
      id = "${id}"
    }
    
    name string
    The unique name of the resulting resource.
    id Input<ID>
    The unique provider ID of the resource to look up.
    state GatewayMigrationGcpState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resulting resource.
    id str
    The unique provider ID of the resource to look up.
    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 resulting resource.
    id IDInput
    The unique provider ID of the resource to look up.
    state GatewayMigrationGcpState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resulting resource.
    id Input<string>
    The unique provider ID of the resource to look up.
    state GatewayMigrationGcpState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resulting resource.
    id Output<String>
    The unique provider ID of the resource to look up.
    state GatewayMigrationGcpState
    Known property values the provider needs, along with the ID, to find the resource. Usually not required.
    options CustomResourceOptions
    Bag of options to control resource's behavior.
    The following state arguments are supported:
    GatewayMigrationGcpId string
    The ID of this resource.
    GcpKey string
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    MigrationId string
    Migration ID
    Name string
    Migration name
    ProtectionKey string
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    Retry GatewayMigrationGcpRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TargetLocation string
    Target location in Akeyless for imported secrets
    GatewayMigrationGcpId string
    The ID of this resource.
    GcpKey string
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    MigrationId string
    Migration ID
    Name string
    Migration name
    ProtectionKey string
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    Retry GatewayMigrationGcpRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    TargetLocation string
    Target location in Akeyless for imported secrets
    gateway_migration_gcp_id string
    The ID of this resource.
    gcp_key string
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    migration_id string
    Migration ID
    name string
    Migration name
    protection_key string
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    retry object
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    target_location string
    Target location in Akeyless for imported secrets
    gatewayMigrationGcpId String
    The ID of this resource.
    gcpKey String
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    migrationId String
    Migration ID
    name String
    Migration name
    protectionKey String
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    retry GatewayMigrationGcpRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetLocation String
    Target location in Akeyless for imported secrets
    gatewayMigrationGcpId string
    The ID of this resource.
    gcpKey string
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    migrationId string
    Migration ID
    name string
    Migration name
    protectionKey string
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    retry GatewayMigrationGcpRetry
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetLocation string
    Target location in Akeyless for imported secrets
    gateway_migration_gcp_id str
    The ID of this resource.
    gcp_key str
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    migration_id str
    Migration ID
    name str
    Migration name
    protection_key str
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    retry GatewayMigrationGcpRetryArgs
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    target_location str
    Target location in Akeyless for imported secrets
    gatewayMigrationGcpId String
    The ID of this resource.
    gcpKey String
    Base64-encoded GCP Service Account private key text with sufficient permissions to Secrets Manager, Minimum required permission is Secret Manager Secret Accessor, e.g. 'roles/secretmanager.secretAccessor' (relevant only for GCP migration)
    migrationId String
    Migration ID
    name String
    Migration name
    protectionKey String
    The name of the key that protects the classic key value (if empty, the account default key will be used)
    retry Property Map
    Retry this resource's operations when the error matches errormessageregex or the HTTP status is in retryonstatus_codes. Overrides the provider retry block. See the Customized Retry guide.
    targetLocation String
    Target location in Akeyless for imported secrets

    Supporting Types

    GatewayMigrationGcpRetry, GatewayMigrationGcpRetryArgs

    ErrorMessageRegexes List<string>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds double
    Maximum wait between retries, in seconds.
    MaxRetries double
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes List<double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    ErrorMessageRegexes []string
    Regular expressions matched against the error message. If any matches, the operation is retried.
    IntervalSeconds float64
    Wait before the first retry, in seconds. The wait doubles on each retry.
    MaxIntervalSeconds float64
    Maximum wait between retries, in seconds.
    MaxRetries float64
    Maximum number of retries after the first attempt.
    RetryOnStatusCodes []float64
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes list(string)
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds number
    Maximum wait between retries, in seconds.
    max_retries number
    Maximum number of retries after the first attempt.
    retry_on_status_codes list(number)
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Double
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Double
    Maximum wait between retries, in seconds.
    maxRetries Double
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Double>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes string[]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds number
    Maximum wait between retries, in seconds.
    maxRetries number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes number[]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    error_message_regexes Sequence[str]
    Regular expressions matched against the error message. If any matches, the operation is retried.
    interval_seconds float
    Wait before the first retry, in seconds. The wait doubles on each retry.
    max_interval_seconds float
    Maximum wait between retries, in seconds.
    max_retries float
    Maximum number of retries after the first attempt.
    retry_on_status_codes Sequence[float]
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.
    errorMessageRegexes List<String>
    Regular expressions matched against the error message. If any matches, the operation is retried.
    intervalSeconds Number
    Wait before the first retry, in seconds. The wait doubles on each retry.
    maxIntervalSeconds Number
    Maximum wait between retries, in seconds.
    maxRetries Number
    Maximum number of retries after the first attempt.
    retryOnStatusCodes List<Number>
    HTTP status codes of the failed API call that trigger a retry, for example 429 or 503.

    Package Details

    Repository
    akeyless akeyless-community/terraform-provider-akeyless
    License
    Notes
    This Pulumi package is based on the akeyless Terraform Provider.
    akeyless
    Viewing docs for akeyless 2.1.0
    published on Thursday, Nov 19, 2026 by akeyless-community

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial