alks 2.8.2, Apr 14 25

alks 2.8.2 published on Monday, Apr 14, 2025 by cox-automotive

alks.Provider

Explore with Pulumi AI

alks 2.8.2 published on Monday, Apr 14, 2025 by cox-automotive

The provider type for the alks package. By default, resources use package-wide configuration settings, however an explicit Provider instance may be created and passed during resource construction to achieve fine-grained programmatic control over provider settings. See the documentation for more information.

Create Provider Resource

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

Constructor syntax

new Provider(name: string, args: ProviderArgs, opts?: CustomResourceOptions);

@overload
def Provider(resource_name: str,
             args: ProviderArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Provider(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             access_key: Optional[str] = None,
             account: Optional[str] = None,
             assume_role: Optional[ProviderAssumeRoleArgs] = None,
             default_tags: Optional[ProviderDefaultTagsArgs] = None,
             ignore_tags: Optional[ProviderIgnoreTagsArgs] = None,
             profile: Optional[str] = None,
             role: Optional[str] = None,
             secret_key: Optional[str] = None,
             shared_credentials_file: Optional[str] = None,
             token: Optional[str] = None,
             url: Optional[str] = None)

func NewProvider(ctx *Context, name string, args ProviderArgs, opts ...ResourceOption) (*Provider, error)

public Provider(string name, ProviderArgs args, CustomResourceOptions? opts = null)

public Provider(String name, ProviderArgs args)
public Provider(String name, ProviderArgs args, CustomResourceOptions options)

type: pulumi:providers:alks
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 ProviderArgs: 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 ProviderArgs: 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 ProviderArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args ProviderArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

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

Url string: This is the base URL to ALKS service. It must be provided, but it can also be sourced from the ALKS_URL environment variable.
AccessKey string: This is the AWS access key. It must be provided, but it can also be sourced from the ALKS_ACCESS_KEY_ID or AWS_ACCESS_KEY_ID environment variable.
Account string: The account which you'd like to retrieve credentials for.
AssumeRole ProviderAssumeRole
DefaultTags ProviderDefaultTags: Configuration block with settings to default resource tags across all resources.
IgnoreTags ProviderIgnoreTags: Configuration block with settings to ignore resource tags across all resources.
Profile string: The profile for API operations. Used in place of STS tokens.
Role string: The role which you'd like to retrieve credentials for.
SecretKey string: This is the AWS secret key. It must be provided, but it can also be sourced from the ALKS_SECRET_ACCESS_KEY or AWS_SECRET_ACCESS_KEY environment variable
SharedCredentialsFile string: The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.
Token string: This is the AWS session token. It must be provided, but it can also be sourced from the ALKS_SESSION_TOKEN or AWS_SESSION_TOKEN environment variable

Url string: This is the base URL to ALKS service. It must be provided, but it can also be sourced from the ALKS_URL environment variable.
AccessKey string: This is the AWS access key. It must be provided, but it can also be sourced from the ALKS_ACCESS_KEY_ID or AWS_ACCESS_KEY_ID environment variable.
Account string: The account which you'd like to retrieve credentials for.
AssumeRole ProviderAssumeRoleArgs
DefaultTags ProviderDefaultTagsArgs: Configuration block with settings to default resource tags across all resources.
IgnoreTags ProviderIgnoreTagsArgs: Configuration block with settings to ignore resource tags across all resources.
Profile string: The profile for API operations. Used in place of STS tokens.
Role string: The role which you'd like to retrieve credentials for.
SecretKey string: This is the AWS secret key. It must be provided, but it can also be sourced from the ALKS_SECRET_ACCESS_KEY or AWS_SECRET_ACCESS_KEY environment variable
SharedCredentialsFile string: The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.
Token string: This is the AWS session token. It must be provided, but it can also be sourced from the ALKS_SESSION_TOKEN or AWS_SESSION_TOKEN environment variable

url String: This is the base URL to ALKS service. It must be provided, but it can also be sourced from the ALKS_URL environment variable.
accessKey String: This is the AWS access key. It must be provided, but it can also be sourced from the ALKS_ACCESS_KEY_ID or AWS_ACCESS_KEY_ID environment variable.
account String: The account which you'd like to retrieve credentials for.
assumeRole ProviderAssumeRole
defaultTags ProviderDefaultTags: Configuration block with settings to default resource tags across all resources.
ignoreTags ProviderIgnoreTags: Configuration block with settings to ignore resource tags across all resources.
profile String: The profile for API operations. Used in place of STS tokens.
role String: The role which you'd like to retrieve credentials for.
secretKey String: This is the AWS secret key. It must be provided, but it can also be sourced from the ALKS_SECRET_ACCESS_KEY or AWS_SECRET_ACCESS_KEY environment variable
sharedCredentialsFile String: The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.
token String: This is the AWS session token. It must be provided, but it can also be sourced from the ALKS_SESSION_TOKEN or AWS_SESSION_TOKEN environment variable

url string: This is the base URL to ALKS service. It must be provided, but it can also be sourced from the ALKS_URL environment variable.
accessKey string: This is the AWS access key. It must be provided, but it can also be sourced from the ALKS_ACCESS_KEY_ID or AWS_ACCESS_KEY_ID environment variable.
account string: The account which you'd like to retrieve credentials for.
assumeRole ProviderAssumeRole
defaultTags ProviderDefaultTags: Configuration block with settings to default resource tags across all resources.
ignoreTags ProviderIgnoreTags: Configuration block with settings to ignore resource tags across all resources.
profile string: The profile for API operations. Used in place of STS tokens.
role string: The role which you'd like to retrieve credentials for.
secretKey string: This is the AWS secret key. It must be provided, but it can also be sourced from the ALKS_SECRET_ACCESS_KEY or AWS_SECRET_ACCESS_KEY environment variable
sharedCredentialsFile string: The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.
token string: This is the AWS session token. It must be provided, but it can also be sourced from the ALKS_SESSION_TOKEN or AWS_SESSION_TOKEN environment variable

url str: This is the base URL to ALKS service. It must be provided, but it can also be sourced from the ALKS_URL environment variable.
access_key str: This is the AWS access key. It must be provided, but it can also be sourced from the ALKS_ACCESS_KEY_ID or AWS_ACCESS_KEY_ID environment variable.
account str: The account which you'd like to retrieve credentials for.
assume_role ProviderAssumeRoleArgs
default_tags ProviderDefaultTagsArgs: Configuration block with settings to default resource tags across all resources.
ignore_tags ProviderIgnoreTagsArgs: Configuration block with settings to ignore resource tags across all resources.
profile str: The profile for API operations. Used in place of STS tokens.
role str: The role which you'd like to retrieve credentials for.
secret_key str: This is the AWS secret key. It must be provided, but it can also be sourced from the ALKS_SECRET_ACCESS_KEY or AWS_SECRET_ACCESS_KEY environment variable
shared_credentials_file str: The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.
token str: This is the AWS session token. It must be provided, but it can also be sourced from the ALKS_SESSION_TOKEN or AWS_SESSION_TOKEN environment variable

url String: This is the base URL to ALKS service. It must be provided, but it can also be sourced from the ALKS_URL environment variable.
accessKey String: This is the AWS access key. It must be provided, but it can also be sourced from the ALKS_ACCESS_KEY_ID or AWS_ACCESS_KEY_ID environment variable.
account String: The account which you'd like to retrieve credentials for.
assumeRole Property Map
defaultTags Property Map: Configuration block with settings to default resource tags across all resources.
ignoreTags Property Map: Configuration block with settings to ignore resource tags across all resources.
profile String: The profile for API operations. Used in place of STS tokens.
role String: The role which you'd like to retrieve credentials for.
secretKey String: This is the AWS secret key. It must be provided, but it can also be sourced from the ALKS_SECRET_ACCESS_KEY or AWS_SECRET_ACCESS_KEY environment variable
sharedCredentialsFile String: The path to the shared credentials file. If not set this defaults to ~/.aws/credentials.
token String: This is the AWS session token. It must be provided, but it can also be sourced from the ALKS_SESSION_TOKEN or AWS_SESSION_TOKEN environment variable

Outputs

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

Supporting Types

ProviderAssumeRole, ProviderAssumeRoleArgs

ExternalId string: (Optional) The external ID to use when making the AssumeRole call. See AWS SDK for more details.
Policy string: (Optional) Additional policy restrictions to apply to the result STS session. See AWS SDK for more details.
RoleArn string: (Required) Role ARN to assume before calling ALKS
SessionName string: (Optional) Session name to use when making the AssumeRole call. See AWS SDK for more details.

ExternalId string: (Optional) The external ID to use when making the AssumeRole call. See AWS SDK for more details.
Policy string: (Optional) Additional policy restrictions to apply to the result STS session. See AWS SDK for more details.
RoleArn string: (Required) Role ARN to assume before calling ALKS
SessionName string: (Optional) Session name to use when making the AssumeRole call. See AWS SDK for more details.

externalId String: (Optional) The external ID to use when making the AssumeRole call. See AWS SDK for more details.
policy String: (Optional) Additional policy restrictions to apply to the result STS session. See AWS SDK for more details.
roleArn String: (Required) Role ARN to assume before calling ALKS
sessionName String: (Optional) Session name to use when making the AssumeRole call. See AWS SDK for more details.

externalId string: (Optional) The external ID to use when making the AssumeRole call. See AWS SDK for more details.
policy string: (Optional) Additional policy restrictions to apply to the result STS session. See AWS SDK for more details.
roleArn string: (Required) Role ARN to assume before calling ALKS
sessionName string: (Optional) Session name to use when making the AssumeRole call. See AWS SDK for more details.

external_id str: (Optional) The external ID to use when making the AssumeRole call. See AWS SDK for more details.
policy str: (Optional) Additional policy restrictions to apply to the result STS session. See AWS SDK for more details.
role_arn str: (Required) Role ARN to assume before calling ALKS
session_name str: (Optional) Session name to use when making the AssumeRole call. See AWS SDK for more details.

externalId String: (Optional) The external ID to use when making the AssumeRole call. See AWS SDK for more details.
policy String: (Optional) Additional policy restrictions to apply to the result STS session. See AWS SDK for more details.
roleArn String: (Required) Role ARN to assume before calling ALKS
sessionName String: (Optional) Session name to use when making the AssumeRole call. See AWS SDK for more details.

ProviderDefaultTags, ProviderDefaultTagsArgs

Tags Dictionary<string, string>: Resource tags to default across all resources

Tags map[string]string: Resource tags to default across all resources

tags Map<String,String>: Resource tags to default across all resources

tags {[key: string]: string}: Resource tags to default across all resources

tags Mapping[str, str]: Resource tags to default across all resources

tags Map<String>: Resource tags to default across all resources

ProviderIgnoreTags, ProviderIgnoreTagsArgs

KeyPrefixes List<string>: Resource tag key prefixes to ignore across all resources.
Keys List<string>: Resource tag keys to ignore across all resources.

KeyPrefixes []string: Resource tag key prefixes to ignore across all resources.
Keys []string: Resource tag keys to ignore across all resources.

keyPrefixes List<String>: Resource tag key prefixes to ignore across all resources.
keys List<String>: Resource tag keys to ignore across all resources.

keyPrefixes string[]: Resource tag key prefixes to ignore across all resources.
keys string[]: Resource tag keys to ignore across all resources.

key_prefixes Sequence[str]: Resource tag key prefixes to ignore across all resources.
keys Sequence[str]: Resource tag keys to ignore across all resources.

keyPrefixes List<String>: Resource tag key prefixes to ignore across all resources.
keys List<String>: Resource tag keys to ignore across all resources.

Package Details

Repository: alks cox-automotive/terraform-provider-alks
License
Notes: This Pulumi package is based on the alks Terraform Provider.

alks 2.8.2 published on Monday, Apr 14, 2025 by cox-automotive

cox-automotive/terraform-provider-alks

alks.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Supporting Types

ProviderAssumeRole, ProviderAssumeRoleArgs

ProviderDefaultTags, ProviderDefaultTagsArgs

ProviderIgnoreTags, ProviderIgnoreTagsArgs

Package Details

On this page

On this page