1. Packages
  2. Qovery
  3. API Docs
  4. AwsCredentials
Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien

qovery.AwsCredentials

Explore with Pulumi AI

qovery logo
Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien

    # qovery.AwsCredentials (Resource)

    Provides a Qovery AWS credentials resource. This can be used to create and manage Qovery AWS credentials.

    Example

    import * as pulumi from "@pulumi/pulumi";
    import * as qovery from "@ediri/qovery";
    
    const myAwsCreds = new qovery.AwsCredentials("myAwsCreds", {
        organizationId: qovery_organization.my_organization.id,
        accessKeyId: "<your-aws-access-key-id>",
        secretAccessKey: "<your-aws-secret-access-key>",
    }, {
        dependsOn: [qovery_organization.my_organization],
    });
    
    import pulumi
    import ediri_qovery as qovery
    
    my_aws_creds = qovery.AwsCredentials("myAwsCreds",
        organization_id=qovery_organization["my_organization"]["id"],
        access_key_id="<your-aws-access-key-id>",
        secret_access_key="<your-aws-secret-access-key>",
        opts=pulumi.ResourceOptions(depends_on=[qovery_organization["my_organization"]]))
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Qovery = ediri.Qovery;
    
    return await Deployment.RunAsync(() => 
    {
        var myAwsCreds = new Qovery.AwsCredentials("myAwsCreds", new()
        {
            OrganizationId = qovery_organization.My_organization.Id,
            AccessKeyId = "<your-aws-access-key-id>",
            SecretAccessKey = "<your-aws-secret-access-key>",
        }, new CustomResourceOptions
        {
            DependsOn = new[]
            {
                qovery_organization.My_organization,
            },
        });
    
    });
    
    package main
    
    import (
    	"github.com/dirien/pulumi-qovery/sdk/go/qovery"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := qovery.NewAwsCredentials(ctx, "myAwsCreds", &qovery.AwsCredentialsArgs{
    			OrganizationId:  pulumi.Any(qovery_organization.My_organization.Id),
    			AccessKeyId:     pulumi.String("<your-aws-access-key-id>"),
    			SecretAccessKey: pulumi.String("<your-aws-secret-access-key>"),
    		}, pulumi.DependsOn([]pulumi.Resource{
    			qovery_organization.My_organization,
    		}))
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.qovery.AwsCredentials;
    import com.pulumi.qovery.AwsCredentialsArgs;
    import com.pulumi.resources.CustomResourceOptions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var myAwsCreds = new AwsCredentials("myAwsCreds", AwsCredentialsArgs.builder()        
                .organizationId(qovery_organization.my_organization().id())
                .accessKeyId("<your-aws-access-key-id>")
                .secretAccessKey("<your-aws-secret-access-key>")
                .build(), CustomResourceOptions.builder()
                    .dependsOn(qovery_organization.my_organization())
                    .build());
    
        }
    }
    
    resources:
      myAwsCreds:
        type: qovery:AwsCredentials
        properties:
          # Required
          organizationId: ${qovery_organization.my_organization.id}
          accessKeyId: <your-aws-access-key-id>
          secretAccessKey: <your-aws-secret-access-key>
        options:
          dependson:
            - ${qovery_organization.my_organization}
    

    Create AwsCredentials Resource

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

    Constructor syntax

    new AwsCredentials(name: string, args: AwsCredentialsArgs, opts?: CustomResourceOptions);
    @overload
    def AwsCredentials(resource_name: str,
                       args: AwsCredentialsArgs,
                       opts: Optional[ResourceOptions] = None)
    
    @overload
    def AwsCredentials(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       access_key_id: Optional[str] = None,
                       organization_id: Optional[str] = None,
                       secret_access_key: Optional[str] = None,
                       name: Optional[str] = None)
    func NewAwsCredentials(ctx *Context, name string, args AwsCredentialsArgs, opts ...ResourceOption) (*AwsCredentials, error)
    public AwsCredentials(string name, AwsCredentialsArgs args, CustomResourceOptions? opts = null)
    public AwsCredentials(String name, AwsCredentialsArgs args)
    public AwsCredentials(String name, AwsCredentialsArgs args, CustomResourceOptions options)
    
    type: qovery:AwsCredentials
    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 AwsCredentialsArgs
    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 AwsCredentialsArgs
    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 AwsCredentialsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AwsCredentialsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AwsCredentialsArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var awsCredentialsResource = new Qovery.AwsCredentials("awsCredentialsResource", new()
    {
        AccessKeyId = "string",
        OrganizationId = "string",
        SecretAccessKey = "string",
        Name = "string",
    });
    
    example, err := qovery.NewAwsCredentials(ctx, "awsCredentialsResource", &qovery.AwsCredentialsArgs{
    	AccessKeyId:     pulumi.String("string"),
    	OrganizationId:  pulumi.String("string"),
    	SecretAccessKey: pulumi.String("string"),
    	Name:            pulumi.String("string"),
    })
    
    var awsCredentialsResource = new AwsCredentials("awsCredentialsResource", AwsCredentialsArgs.builder()        
        .accessKeyId("string")
        .organizationId("string")
        .secretAccessKey("string")
        .name("string")
        .build());
    
    aws_credentials_resource = qovery.AwsCredentials("awsCredentialsResource",
        access_key_id="string",
        organization_id="string",
        secret_access_key="string",
        name="string")
    
    const awsCredentialsResource = new qovery.AwsCredentials("awsCredentialsResource", {
        accessKeyId: "string",
        organizationId: "string",
        secretAccessKey: "string",
        name: "string",
    });
    
    type: qovery:AwsCredentials
    properties:
        accessKeyId: string
        name: string
        organizationId: string
        secretAccessKey: string
    

    AwsCredentials Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AwsCredentials resource accepts the following input properties:

    AccessKeyId string
    Your AWS access key id.
    OrganizationId string
    Id of the organization.
    SecretAccessKey string
    Your AWS secret access key.
    Name string
    Name of the aws credentials.
    AccessKeyId string
    Your AWS access key id.
    OrganizationId string
    Id of the organization.
    SecretAccessKey string
    Your AWS secret access key.
    Name string
    Name of the aws credentials.
    accessKeyId String
    Your AWS access key id.
    organizationId String
    Id of the organization.
    secretAccessKey String
    Your AWS secret access key.
    name String
    Name of the aws credentials.
    accessKeyId string
    Your AWS access key id.
    organizationId string
    Id of the organization.
    secretAccessKey string
    Your AWS secret access key.
    name string
    Name of the aws credentials.
    access_key_id str
    Your AWS access key id.
    organization_id str
    Id of the organization.
    secret_access_key str
    Your AWS secret access key.
    name str
    Name of the aws credentials.
    accessKeyId String
    Your AWS access key id.
    organizationId String
    Id of the organization.
    secretAccessKey String
    Your AWS secret access key.
    name String
    Name of the aws credentials.

    Outputs

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

    Get an existing AwsCredentials 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?: AwsCredentialsState, opts?: CustomResourceOptions): AwsCredentials
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            access_key_id: Optional[str] = None,
            name: Optional[str] = None,
            organization_id: Optional[str] = None,
            secret_access_key: Optional[str] = None) -> AwsCredentials
    func GetAwsCredentials(ctx *Context, name string, id IDInput, state *AwsCredentialsState, opts ...ResourceOption) (*AwsCredentials, error)
    public static AwsCredentials Get(string name, Input<string> id, AwsCredentialsState? state, CustomResourceOptions? opts = null)
    public static AwsCredentials get(String name, Output<String> id, AwsCredentialsState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    AccessKeyId string
    Your AWS access key id.
    Name string
    Name of the aws credentials.
    OrganizationId string
    Id of the organization.
    SecretAccessKey string
    Your AWS secret access key.
    AccessKeyId string
    Your AWS access key id.
    Name string
    Name of the aws credentials.
    OrganizationId string
    Id of the organization.
    SecretAccessKey string
    Your AWS secret access key.
    accessKeyId String
    Your AWS access key id.
    name String
    Name of the aws credentials.
    organizationId String
    Id of the organization.
    secretAccessKey String
    Your AWS secret access key.
    accessKeyId string
    Your AWS access key id.
    name string
    Name of the aws credentials.
    organizationId string
    Id of the organization.
    secretAccessKey string
    Your AWS secret access key.
    access_key_id str
    Your AWS access key id.
    name str
    Name of the aws credentials.
    organization_id str
    Id of the organization.
    secret_access_key str
    Your AWS secret access key.
    accessKeyId String
    Your AWS access key id.
    name String
    Name of the aws credentials.
    organizationId String
    Id of the organization.
    secretAccessKey String
    Your AWS secret access key.

    Import

     $ pulumi import qovery:index/awsCredentials:AwsCredentials my_aws_creds "<organization_id>,<aws_credentials_id>"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    qovery dirien/pulumi-qovery
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the qovery Terraform Provider.
    qovery logo
    Qovery v0.28.8 published on Sunday, Mar 3, 2024 by dirien