pulumi-vault-kotlin/com.pulumi.vault.aws.kotlin/AwsFunctions/getAccessCredentials

getAccessCredentials

suspend fun getAccessCredentials(argument: GetAccessCredentialsPlainArgs): GetAccessCredentialsResult

Example Usage

resources:
  aws:
    type: vault:aws:SecretBackend
    properties:
      accessKey: AKIA.....
      secretKey: SECRETKEYFROMAWS
  role:
    type: vault:aws:SecretBackendRole
    properties:
      backend: ${aws.path}
      name: test
      policy: |
        {
          "Version": "2012-10-17",
          "Statement": [
            {
              "Effect": "Allow",
              "Action": "iam:*",
              "Resource": "*"
            }
          ]
        }
variables:
  # generally, these blocks would be in a different module
  creds:
    fn::invoke:
      function: vault:aws:getAccessCredentials
      arguments:
        backend: ${aws.path}
        role: ${role.name}
Content copied to clipboard

Return

A collection of values returned by getAccessCredentials.

Parameters

argument

A collection of arguments for invoking getAccessCredentials.

suspend fun getAccessCredentials(backend: String, namespace: String? = null, region: String? = null, role: String, roleArn: String? = null, ttl: String? = null, type: String? = null): GetAccessCredentialsResult

Return

A collection of values returned by getAccessCredentials.

Parameters

backend

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

namespace

The namespace of the target resource. The value should not contain leading or trailing forward slashes. The namespace is always relative to the provider's configured namespace. Available only for Vault Enterprise.

region

The region the read credentials belong to.

role

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

roleArn

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

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 of the connected vault.aws.SecretBackendRole resource is assumed_role or federation_token

type

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.

See also

.

suspend fun getAccessCredentials(argument: suspend GetAccessCredentialsPlainArgsBuilder.() -> Unit): GetAccessCredentialsResult

Return

A collection of values returned by getAccessCredentials.

Parameters

argument

Builder for com.pulumi.vault.aws.kotlin.inputs.GetAccessCredentialsPlainArgs.

See also

.