getAccessCredentials

Using getAccessCredentials

function getAccessCredentials(args: GetAccessCredentialsArgs, opts?: InvokeOptions): Promise<GetAccessCredentialsResult>
def get_access_credentials(backend: Optional[str] = None,
                           region: Optional[str] = None,
                           role: Optional[str] = None,
                           role_arn: Optional[str] = None,
                           ttl: Optional[str] = None,
                           type: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetAccessCredentialsResult
func GetAccessCredentials(ctx *Context, args *GetAccessCredentialsArgs, opts ...InvokeOption) (*GetAccessCredentialsResult, error)

Note: This function is named GetAccessCredentials in the Go SDK.

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.
Region string
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.
Ttl string
Specifies the TTL for the use of the STS token. This is specified as a string with a duration suffix. Valid only when credential_type is assumed_role or federation_token
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.
Region string
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.
Ttl string
Specifies the TTL for the use of the STS token. This is specified as a string with a duration suffix. Valid only when credential_type is assumed_role or federation_token
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.
region string
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.
ttl string
Specifies the TTL for the use of the STS token. This is specified as a string with a duration suffix. Valid only when credential_type is assumed_role or federation_token
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.
region str
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.
ttl str
Specifies the TTL for the use of the STS token. This is specified as a string with a duration suffix. Valid only when credential_type is assumed_role or federation_token
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.
Region string
RoleArn string
Ttl 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.
Region string
RoleArn string
Ttl 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.
region string
roleArn string
ttl 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 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.
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.
region str
role_arn str
ttl 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.