1. Docs
  2. Reference
  3. API
  4. Vault
  5. aws
  6. GetAccessCredentials

GetAccessCredentials

Using GetAccessCredentials

function getAccessCredentials(args: GetAccessCredentialsArgs, opts?: InvokeOptions): Promise<GetAccessCredentialsResult>
function  get_access_credentials(backend=None, role=None, role_arn=None, type=None, opts=None)
func GetAccessCredentials(ctx *Context, args *GetAccessCredentialsArgs, opts ...InvokeOption) (*GetAccessCredentialsResult, error)
public static class GetAccessCredentials {
    public static Task<GetAccessCredentialsResult> InvokeAsync(GetAccessCredentialsArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Backend string

The path to the AWS secret backend to read credentials from, with no leading or trailing /s.

Role string

The name of the AWS secret backend role to read credentials from, with no leading or trailing /s.

RoleArn string

The specific AWS ARN to use from the configured role. If the role does not have multiple ARNs, this does not need to be specified.

Type string

The type of credentials to read. Defaults to "creds", which just returns an AWS Access Key ID and Secret Key. Can also be set to "sts", which will return a security token in addition to the keys.

Backend string

The path to the AWS secret backend to read credentials from, with no leading or trailing /s.

Role string

The name of the AWS secret backend role to read credentials from, with no leading or trailing /s.

RoleArn string

The specific AWS ARN to use from the configured role. If the role does not have multiple ARNs, this does not need to be specified.

Type string

The type of credentials to read. Defaults to "creds", which just returns an AWS Access Key ID and Secret Key. Can also be set to "sts", which will return a security token in addition to the keys.

backend string

The path to the AWS secret backend to read credentials from, with no leading or trailing /s.

role string

The name of the AWS secret backend role to read credentials from, with no leading or trailing /s.

roleArn string

The specific AWS ARN to use from the configured role. If the role does not have multiple ARNs, this does not need to be specified.

type string

The type of credentials to read. Defaults to "creds", which just returns an AWS Access Key ID and Secret Key. Can also be set to "sts", which will return a security token in addition to the keys.

backend str

The path to the AWS secret backend to read credentials from, with no leading or trailing /s.

role str

The name of the AWS secret backend role to read credentials from, with no leading or trailing /s.

role_arn str

The specific AWS ARN to use from the configured role. If the role does not have multiple ARNs, this does not need to be specified.

type str

The type of credentials to read. Defaults to "creds", which just returns an AWS Access Key ID and Secret Key. Can also be set to "sts", which will return a security token in addition to the keys.

GetAccessCredentials Result

The following output properties are available:

AccessKey string

The AWS Access Key ID returned by Vault.

Backend string
Id string

The provider-assigned unique ID for this managed resource.

LeaseDuration int

The duration of the secret lease, in seconds relative to the time the data was requested. Once this time has passed any plan generated with this data may fail to apply.

LeaseId string

The lease identifier assigned by Vault.

LeaseRenewable bool
LeaseStartTime string
Role string
SecretKey string

The AWS Secret Key returned by Vault.

SecurityToken string

The STS token returned by Vault, if any.

RoleArn string
Type string
AccessKey string

The AWS Access Key ID returned by Vault.

Backend string
Id string

The provider-assigned unique ID for this managed resource.

LeaseDuration int

The duration of the secret lease, in seconds relative to the time the data was requested. Once this time has passed any plan generated with this data may fail to apply.

LeaseId string

The lease identifier assigned by Vault.

LeaseRenewable bool
LeaseStartTime string
Role string
SecretKey string

The AWS Secret Key returned by Vault.

SecurityToken string

The STS token returned by Vault, if any.

RoleArn string
Type string
accessKey string

The AWS Access Key ID returned by Vault.

backend string
id string

The provider-assigned unique ID for this managed resource.

leaseDuration number

The duration of the secret lease, in seconds relative to the time the data was requested. Once this time has passed any plan generated with this data may fail to apply.

leaseId string

The lease identifier assigned by Vault.

leaseRenewable boolean
leaseStartTime string
role string
secretKey string

The AWS Secret Key returned by Vault.

securityToken string

The STS token returned by Vault, if any.

roleArn string
type string
access_key str

The AWS Access Key ID returned by Vault.

backend str
id str

The provider-assigned unique ID for this managed resource.

lease_duration float

The duration of the secret lease, in seconds relative to the time the data was requested. Once this time has passed any plan generated with this data may fail to apply.

lease_id str

The lease identifier assigned by Vault.

lease_renewable bool
lease_start_time str
role str
secret_key str

The AWS Secret Key returned by Vault.

security_token str

The STS token returned by Vault, if any.

role_arn str
type str

Package Details

Repository
https://github.com/pulumi/pulumi-vault
License
Apache-2.0
Notes
This Pulumi package is based on the vault Terraform Provider.