akeyless.GatewayMigrationAws

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 GatewayMigrationAws Resource

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

Constructor syntax

new GatewayMigrationAws(name: string, args: GatewayMigrationAwsArgs, opts?: CustomResourceOptions);

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

@overload
def GatewayMigrationAws(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        target_location: Optional[str] = None,
                        aws_key: Optional[str] = None,
                        aws_key_id: Optional[str] = None,
                        aws_region: Optional[str] = None,
                        gateway_migration_aws_id: Optional[str] = None,
                        name: Optional[str] = None,
                        protection_key: Optional[str] = None)

func NewGatewayMigrationAws(ctx *Context, name string, args GatewayMigrationAwsArgs, opts ...ResourceOption) (*GatewayMigrationAws, error)

public GatewayMigrationAws(string name, GatewayMigrationAwsArgs args, CustomResourceOptions? opts = null)

public GatewayMigrationAws(String name, GatewayMigrationAwsArgs args)
public GatewayMigrationAws(String name, GatewayMigrationAwsArgs args, CustomResourceOptions options)

type: akeyless:GatewayMigrationAws
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 GatewayMigrationAwsArgs: 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 GatewayMigrationAwsArgs: 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 GatewayMigrationAwsArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args GatewayMigrationAwsArgs: 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 gatewayMigrationAwsResource = new Akeyless.GatewayMigrationAws("gatewayMigrationAwsResource", new()
{
    TargetLocation = "string",
    AwsKey = "string",
    AwsKeyId = "string",
    AwsRegion = "string",
    GatewayMigrationAwsId = "string",
    Name = "string",
    ProtectionKey = "string",
});

example, err := akeyless.NewGatewayMigrationAws(ctx, "gatewayMigrationAwsResource", &akeyless.GatewayMigrationAwsArgs{
	TargetLocation:        pulumi.String("string"),
	AwsKey:                pulumi.String("string"),
	AwsKeyId:              pulumi.String("string"),
	AwsRegion:             pulumi.String("string"),
	GatewayMigrationAwsId: pulumi.String("string"),
	Name:                  pulumi.String("string"),
	ProtectionKey:         pulumi.String("string"),
})

var gatewayMigrationAwsResource = new GatewayMigrationAws("gatewayMigrationAwsResource", GatewayMigrationAwsArgs.builder()
    .targetLocation("string")
    .awsKey("string")
    .awsKeyId("string")
    .awsRegion("string")
    .gatewayMigrationAwsId("string")
    .name("string")
    .protectionKey("string")
    .build());

gateway_migration_aws_resource = akeyless.GatewayMigrationAws("gatewayMigrationAwsResource",
    target_location="string",
    aws_key="string",
    aws_key_id="string",
    aws_region="string",
    gateway_migration_aws_id="string",
    name="string",
    protection_key="string")

const gatewayMigrationAwsResource = new akeyless.GatewayMigrationAws("gatewayMigrationAwsResource", {
    targetLocation: "string",
    awsKey: "string",
    awsKeyId: "string",
    awsRegion: "string",
    gatewayMigrationAwsId: "string",
    name: "string",
    protectionKey: "string",
});

type: akeyless:GatewayMigrationAws
properties:
    awsKey: string
    awsKeyId: string
    awsRegion: string
    gatewayMigrationAwsId: string
    name: string
    protectionKey: string
    targetLocation: string

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

TargetLocation string: Target location in Akeyless for imported secrets
AwsKey string: AWS Secret Access Key (relevant only for AWS migration)
AwsKeyId string: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
AwsRegion string: AWS region of the required Secrets Manager (relevant only for AWS migration)
GatewayMigrationAwsId string: The ID of this resource.
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)

TargetLocation string: Target location in Akeyless for imported secrets
AwsKey string: AWS Secret Access Key (relevant only for AWS migration)
AwsKeyId string: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
AwsRegion string: AWS region of the required Secrets Manager (relevant only for AWS migration)
GatewayMigrationAwsId string: The ID of this resource.
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)

targetLocation String: Target location in Akeyless for imported secrets
awsKey String: AWS Secret Access Key (relevant only for AWS migration)
awsKeyId String: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
awsRegion String: AWS region of the required Secrets Manager (relevant only for AWS migration)
gatewayMigrationAwsId String: The ID of this resource.
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)

targetLocation string: Target location in Akeyless for imported secrets
awsKey string: AWS Secret Access Key (relevant only for AWS migration)
awsKeyId string: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
awsRegion string: AWS region of the required Secrets Manager (relevant only for AWS migration)
gatewayMigrationAwsId string: The ID of this resource.
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)

target_location str: Target location in Akeyless for imported secrets
aws_key str: AWS Secret Access Key (relevant only for AWS migration)
aws_key_id str: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
aws_region str: AWS region of the required Secrets Manager (relevant only for AWS migration)
gateway_migration_aws_id str: The ID of this resource.
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)

targetLocation String: Target location in Akeyless for imported secrets
awsKey String: AWS Secret Access Key (relevant only for AWS migration)
awsKeyId String: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
awsRegion String: AWS region of the required Secrets Manager (relevant only for AWS migration)
gatewayMigrationAwsId String: The ID of this resource.
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)

Outputs

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

Get an existing GatewayMigrationAws 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?: GatewayMigrationAwsState, opts?: CustomResourceOptions): GatewayMigrationAws

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        aws_key: Optional[str] = None,
        aws_key_id: Optional[str] = None,
        aws_region: Optional[str] = None,
        gateway_migration_aws_id: Optional[str] = None,
        migration_id: Optional[str] = None,
        name: Optional[str] = None,
        protection_key: Optional[str] = None,
        target_location: Optional[str] = None) -> GatewayMigrationAws

func GetGatewayMigrationAws(ctx *Context, name string, id IDInput, state *GatewayMigrationAwsState, opts ...ResourceOption) (*GatewayMigrationAws, error)

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

public static GatewayMigrationAws get(String name, Output<String> id, GatewayMigrationAwsState state, CustomResourceOptions options)

resources:  _:    type: akeyless:GatewayMigrationAws    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:

AwsKey string: AWS Secret Access Key (relevant only for AWS migration)
AwsKeyId string: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
AwsRegion string: AWS region of the required Secrets Manager (relevant only for AWS migration)
GatewayMigrationAwsId string: The ID of this resource.
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)
TargetLocation string: Target location in Akeyless for imported secrets

AwsKey string: AWS Secret Access Key (relevant only for AWS migration)
AwsKeyId string: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
AwsRegion string: AWS region of the required Secrets Manager (relevant only for AWS migration)
GatewayMigrationAwsId string: The ID of this resource.
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)
TargetLocation string: Target location in Akeyless for imported secrets

awsKey String: AWS Secret Access Key (relevant only for AWS migration)
awsKeyId String: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
awsRegion String: AWS region of the required Secrets Manager (relevant only for AWS migration)
gatewayMigrationAwsId String: The ID of this resource.
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)
targetLocation String: Target location in Akeyless for imported secrets

awsKey string: AWS Secret Access Key (relevant only for AWS migration)
awsKeyId string: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
awsRegion string: AWS region of the required Secrets Manager (relevant only for AWS migration)
gatewayMigrationAwsId string: The ID of this resource.
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)
targetLocation string: Target location in Akeyless for imported secrets

aws_key str: AWS Secret Access Key (relevant only for AWS migration)
aws_key_id str: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
aws_region str: AWS region of the required Secrets Manager (relevant only for AWS migration)
gateway_migration_aws_id str: The ID of this resource.
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)
target_location str: Target location in Akeyless for imported secrets

awsKey String: AWS Secret Access Key (relevant only for AWS migration)
awsKeyId String: AWS Access Key ID with sufficient permissions to get all secrets, e.g. 'arn:aws:secretsmanager:[Region]:[AccountId]:secret:[/path/to/secrets/_*]' (relevant only for AWS migration)
awsRegion String: AWS region of the required Secrets Manager (relevant only for AWS migration)
gatewayMigrationAwsId String: The ID of this resource.
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)
targetLocation String: Target location in Akeyless for imported secrets