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

akeyless.TargetAws

Explore with Pulumi AI

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

    AWS Target resource

    Create TargetAws Resource

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

    Constructor syntax

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

@overload
def TargetAws(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              access_key_id: Optional[str] = None,
              access_key: Optional[str] = None,
              description: Optional[str] = None,
              key: Optional[str] = None,
              name: Optional[str] = None,
              region: Optional[str] = None,
              session_token: Optional[str] = None,
              target_aws_id: Optional[str] = None,
              use_gw_cloud_identity: Optional[bool] = None)
    func NewTargetAws(ctx *Context, name string, args TargetAwsArgs, opts ...ResourceOption) (*TargetAws, error)
    public TargetAws(string name, TargetAwsArgs args, CustomResourceOptions? opts = null)
    public TargetAws(String name, TargetAwsArgs args)
public TargetAws(String name, TargetAwsArgs args, CustomResourceOptions options)

    type: akeyless:TargetAws
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 TargetAwsArgs
    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 TargetAwsArgs
    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 TargetAwsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TargetAwsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TargetAwsArgs
    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 targetAwsResource = new Akeyless.TargetAws("targetAwsResource", new()
{
    AccessKeyId = "string",
    AccessKey = "string",
    Description = "string",
    Key = "string",
    Name = "string",
    Region = "string",
    SessionToken = "string",
    TargetAwsId = "string",
    UseGwCloudIdentity = false,
});

    example, err := akeyless.NewTargetAws(ctx, "targetAwsResource", &akeyless.TargetAwsArgs{
	AccessKeyId:        pulumi.String("string"),
	AccessKey:          pulumi.String("string"),
	Description:        pulumi.String("string"),
	Key:                pulumi.String("string"),
	Name:               pulumi.String("string"),
	Region:             pulumi.String("string"),
	SessionToken:       pulumi.String("string"),
	TargetAwsId:        pulumi.String("string"),
	UseGwCloudIdentity: pulumi.Bool(false),
})

    var targetAwsResource = new TargetAws("targetAwsResource", TargetAwsArgs.builder()
    .accessKeyId("string")
    .accessKey("string")
    .description("string")
    .key("string")
    .name("string")
    .region("string")
    .sessionToken("string")
    .targetAwsId("string")
    .useGwCloudIdentity(false)
    .build());

    target_aws_resource = akeyless.TargetAws("targetAwsResource",
    access_key_id="string",
    access_key="string",
    description="string",
    key="string",
    name="string",
    region="string",
    session_token="string",
    target_aws_id="string",
    use_gw_cloud_identity=False)

    const targetAwsResource = new akeyless.TargetAws("targetAwsResource", {
    accessKeyId: "string",
    accessKey: "string",
    description: "string",
    key: "string",
    name: "string",
    region: "string",
    sessionToken: "string",
    targetAwsId: "string",
    useGwCloudIdentity: false,
});

    type: akeyless:TargetAws
properties:
    accessKey: string
    accessKeyId: string
    description: string
    key: string
    name: string
    region: string
    sessionToken: string
    targetAwsId: string
    useGwCloudIdentity: false

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

    AccessKeyId string
    AWS access key ID
    AccessKey string
    AWS secret access key
    Description string
    Description of the object
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    Name string
    Target name
    Region string
    AWS region
    SessionToken string
    Required only for temporary security credentials retrieved using STS
    TargetAwsId string
    The ID of this resource.
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    AccessKeyId string
    AWS access key ID
    AccessKey string
    AWS secret access key
    Description string
    Description of the object
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    Name string
    Target name
    Region string
    AWS region
    SessionToken string
    Required only for temporary security credentials retrieved using STS
    TargetAwsId string
    The ID of this resource.
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    accessKeyId String
    AWS access key ID
    accessKey String
    AWS secret access key
    description String
    Description of the object
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name String
    Target name
    region String
    AWS region
    sessionToken String
    Required only for temporary security credentials retrieved using STS
    targetAwsId String
    The ID of this resource.
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM
    accessKeyId string
    AWS access key ID
    accessKey string
    AWS secret access key
    description string
    Description of the object
    key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name string
    Target name
    region string
    AWS region
    sessionToken string
    Required only for temporary security credentials retrieved using STS
    targetAwsId string
    The ID of this resource.
    useGwCloudIdentity boolean
    Use the GW's Cloud IAM
    access_key_id str
    AWS access key ID
    access_key str
    AWS secret access key
    description str
    Description of the object
    key str
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name str
    Target name
    region str
    AWS region
    session_token str
    Required only for temporary security credentials retrieved using STS
    target_aws_id str
    The ID of this resource.
    use_gw_cloud_identity bool
    Use the GW's Cloud IAM
    accessKeyId String
    AWS access key ID
    accessKey String
    AWS secret access key
    description String
    Description of the object
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name String
    Target name
    region String
    AWS region
    sessionToken String
    Required only for temporary security credentials retrieved using STS
    targetAwsId String
    The ID of this resource.
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM

    Outputs

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

    Get an existing TargetAws 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?: TargetAwsState, opts?: CustomResourceOptions): TargetAws
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        access_key: Optional[str] = None,
        access_key_id: Optional[str] = None,
        description: Optional[str] = None,
        key: Optional[str] = None,
        name: Optional[str] = None,
        region: Optional[str] = None,
        session_token: Optional[str] = None,
        target_aws_id: Optional[str] = None,
        use_gw_cloud_identity: Optional[bool] = None) -> TargetAws
    func GetTargetAws(ctx *Context, name string, id IDInput, state *TargetAwsState, opts ...ResourceOption) (*TargetAws, error)
    public static TargetAws Get(string name, Input<string> id, TargetAwsState? state, CustomResourceOptions? opts = null)
    public static TargetAws get(String name, Output<String> id, TargetAwsState state, CustomResourceOptions options)
    resources:  _:    type: akeyless:TargetAws    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:
    AccessKey string
    AWS secret access key
    AccessKeyId string
    AWS access key ID
    Description string
    Description of the object
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    Name string
    Target name
    Region string
    AWS region
    SessionToken string
    Required only for temporary security credentials retrieved using STS
    TargetAwsId string
    The ID of this resource.
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    AccessKey string
    AWS secret access key
    AccessKeyId string
    AWS access key ID
    Description string
    Description of the object
    Key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    Name string
    Target name
    Region string
    AWS region
    SessionToken string
    Required only for temporary security credentials retrieved using STS
    TargetAwsId string
    The ID of this resource.
    UseGwCloudIdentity bool
    Use the GW's Cloud IAM
    accessKey String
    AWS secret access key
    accessKeyId String
    AWS access key ID
    description String
    Description of the object
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name String
    Target name
    region String
    AWS region
    sessionToken String
    Required only for temporary security credentials retrieved using STS
    targetAwsId String
    The ID of this resource.
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM
    accessKey string
    AWS secret access key
    accessKeyId string
    AWS access key ID
    description string
    Description of the object
    key string
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name string
    Target name
    region string
    AWS region
    sessionToken string
    Required only for temporary security credentials retrieved using STS
    targetAwsId string
    The ID of this resource.
    useGwCloudIdentity boolean
    Use the GW's Cloud IAM
    access_key str
    AWS secret access key
    access_key_id str
    AWS access key ID
    description str
    Description of the object
    key str
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name str
    Target name
    region str
    AWS region
    session_token str
    Required only for temporary security credentials retrieved using STS
    target_aws_id str
    The ID of this resource.
    use_gw_cloud_identity bool
    Use the GW's Cloud IAM
    accessKey String
    AWS secret access key
    accessKeyId String
    AWS access key ID
    description String
    Description of the object
    key String
    Key name. The key will be used to encrypt the target secret value. If key name is not specified, the account default protection key is used
    name String
    Target name
    region String
    AWS region
    sessionToken String
    Required only for temporary security credentials retrieved using STS
    targetAwsId String
    The ID of this resource.
    useGwCloudIdentity Boolean
    Use the GW's Cloud IAM

    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