AWS Control Tower v0.0.2, Oct 20 23

AWS Control Tower v0.0.2 published on Friday, Oct 20, 2023 by lbrlabs

awscontroltower.Provider

Explore with Pulumi AI

AWS Control Tower v0.0.2 published on Friday, Oct 20, 2023 by lbrlabs

The provider type for the awscontroltower 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,
             assume_role: Optional[ProviderAssumeRoleArgs] = None,
             max_retries: Optional[int] = None,
             profile: Optional[str] = None,
             region: Optional[str] = None,
             secret_key: Optional[str] = None,
             shared_credentials_file: Optional[str] = None,
             skip_credentials_validation: Optional[bool] = None,
             skip_metadata_api_check: Optional[bool] = None,
             skip_requesting_account_id: Optional[bool] = None,
             token: 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:awscontroltower
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

The Provider resource accepts the following input properties:

Region string: This is the AWS region. It must be provided, but it can also be sourced from the AWS_DEFAULT_REGION environment variables, or via a shared credentials file if profile is specified.
AccessKey string: This is the AWS access key. It must be provided, but it can also be sourced from the AWS_ACCESS_KEY_ID environment variable, or via a shared credentials file if profile is specified.
AssumeRole Lbrlabs.PulumiPackage.Awscontroltower.Inputs.ProviderAssumeRole: Settings for making use of the AWS Assume Role functionality.
MaxRetries int: This is the maximum number of times an API call is retried, in the case where requests are being throttled or experiencing transient failures. The delay between the subsequent API calls increases exponentially. If omitted, the default value is 25.
Profile string: This is the AWS profile name as set in the shared credentials file.
SecretKey string: This is the AWS secret key. It must be provided, but it can also be sourced from the AWS_SECRET_ACCESS_KEY environment variable, or via a shared credentials file if profile is specified.
SharedCredentialsFile string: This is the path to the shared credentials file. If this is not set and a profile is specified, ~/.aws/credentials will be used.
SkipCredentialsValidation bool: Skip the credentials validation via the STS API. Useful for AWS API implementations that do not have STS available or implemented.
SkipMetadataApiCheck bool: Skip the AWS Metadata API check. Useful for AWS API implementations that do not have a metadata API endpoint. Setting to true prevents Terraform from authenticating via the Metadata API. You may need to use other authentication methods like static credentials, configuration variables, or environment variables.
SkipRequestingAccountId bool: Skip requesting the account ID. Useful for AWS API implementations that do not have the IAM, STS API, or metadata API.
Token string: Session token for validating temporary credentials. Typically provided after successful identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit MFA code used to get temporary credentials. It can also be sourced from the AWS_SESSION_TOKEN environment variable.

Region string: This is the AWS region. It must be provided, but it can also be sourced from the AWS_DEFAULT_REGION environment variables, or via a shared credentials file if profile is specified.
AccessKey string: This is the AWS access key. It must be provided, but it can also be sourced from the AWS_ACCESS_KEY_ID environment variable, or via a shared credentials file if profile is specified.
AssumeRole ProviderAssumeRoleArgs: Settings for making use of the AWS Assume Role functionality.
MaxRetries int: This is the maximum number of times an API call is retried, in the case where requests are being throttled or experiencing transient failures. The delay between the subsequent API calls increases exponentially. If omitted, the default value is 25.
Profile string: This is the AWS profile name as set in the shared credentials file.
SecretKey string: This is the AWS secret key. It must be provided, but it can also be sourced from the AWS_SECRET_ACCESS_KEY environment variable, or via a shared credentials file if profile is specified.
SharedCredentialsFile string: This is the path to the shared credentials file. If this is not set and a profile is specified, ~/.aws/credentials will be used.
SkipCredentialsValidation bool: Skip the credentials validation via the STS API. Useful for AWS API implementations that do not have STS available or implemented.
SkipMetadataApiCheck bool: Skip the AWS Metadata API check. Useful for AWS API implementations that do not have a metadata API endpoint. Setting to true prevents Terraform from authenticating via the Metadata API. You may need to use other authentication methods like static credentials, configuration variables, or environment variables.
SkipRequestingAccountId bool: Skip requesting the account ID. Useful for AWS API implementations that do not have the IAM, STS API, or metadata API.
Token string: Session token for validating temporary credentials. Typically provided after successful identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit MFA code used to get temporary credentials. It can also be sourced from the AWS_SESSION_TOKEN environment variable.

region String: This is the AWS region. It must be provided, but it can also be sourced from the AWS_DEFAULT_REGION environment variables, or via a shared credentials file if profile is specified.
accessKey String: This is the AWS access key. It must be provided, but it can also be sourced from the AWS_ACCESS_KEY_ID environment variable, or via a shared credentials file if profile is specified.
assumeRole ProviderAssumeRole: Settings for making use of the AWS Assume Role functionality.
maxRetries Integer: This is the maximum number of times an API call is retried, in the case where requests are being throttled or experiencing transient failures. The delay between the subsequent API calls increases exponentially. If omitted, the default value is 25.
profile String: This is the AWS profile name as set in the shared credentials file.
secretKey String: This is the AWS secret key. It must be provided, but it can also be sourced from the AWS_SECRET_ACCESS_KEY environment variable, or via a shared credentials file if profile is specified.
sharedCredentialsFile String: This is the path to the shared credentials file. If this is not set and a profile is specified, ~/.aws/credentials will be used.
skipCredentialsValidation Boolean: Skip the credentials validation via the STS API. Useful for AWS API implementations that do not have STS available or implemented.
skipMetadataApiCheck Boolean: Skip the AWS Metadata API check. Useful for AWS API implementations that do not have a metadata API endpoint. Setting to true prevents Terraform from authenticating via the Metadata API. You may need to use other authentication methods like static credentials, configuration variables, or environment variables.
skipRequestingAccountId Boolean: Skip requesting the account ID. Useful for AWS API implementations that do not have the IAM, STS API, or metadata API.
token String: Session token for validating temporary credentials. Typically provided after successful identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit MFA code used to get temporary credentials. It can also be sourced from the AWS_SESSION_TOKEN environment variable.

region string: This is the AWS region. It must be provided, but it can also be sourced from the AWS_DEFAULT_REGION environment variables, or via a shared credentials file if profile is specified.
accessKey string: This is the AWS access key. It must be provided, but it can also be sourced from the AWS_ACCESS_KEY_ID environment variable, or via a shared credentials file if profile is specified.
assumeRole ProviderAssumeRole: Settings for making use of the AWS Assume Role functionality.
maxRetries number: This is the maximum number of times an API call is retried, in the case where requests are being throttled or experiencing transient failures. The delay between the subsequent API calls increases exponentially. If omitted, the default value is 25.
profile string: This is the AWS profile name as set in the shared credentials file.
secretKey string: This is the AWS secret key. It must be provided, but it can also be sourced from the AWS_SECRET_ACCESS_KEY environment variable, or via a shared credentials file if profile is specified.
sharedCredentialsFile string: This is the path to the shared credentials file. If this is not set and a profile is specified, ~/.aws/credentials will be used.
skipCredentialsValidation boolean: Skip the credentials validation via the STS API. Useful for AWS API implementations that do not have STS available or implemented.
skipMetadataApiCheck boolean: Skip the AWS Metadata API check. Useful for AWS API implementations that do not have a metadata API endpoint. Setting to true prevents Terraform from authenticating via the Metadata API. You may need to use other authentication methods like static credentials, configuration variables, or environment variables.
skipRequestingAccountId boolean: Skip requesting the account ID. Useful for AWS API implementations that do not have the IAM, STS API, or metadata API.
token string: Session token for validating temporary credentials. Typically provided after successful identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit MFA code used to get temporary credentials. It can also be sourced from the AWS_SESSION_TOKEN environment variable.

region str: This is the AWS region. It must be provided, but it can also be sourced from the AWS_DEFAULT_REGION environment variables, or via a shared credentials file if profile is specified.
access_key str: This is the AWS access key. It must be provided, but it can also be sourced from the AWS_ACCESS_KEY_ID environment variable, or via a shared credentials file if profile is specified.
assume_role ProviderAssumeRoleArgs: Settings for making use of the AWS Assume Role functionality.
max_retries int: This is the maximum number of times an API call is retried, in the case where requests are being throttled or experiencing transient failures. The delay between the subsequent API calls increases exponentially. If omitted, the default value is 25.
profile str: This is the AWS profile name as set in the shared credentials file.
secret_key str: This is the AWS secret key. It must be provided, but it can also be sourced from the AWS_SECRET_ACCESS_KEY environment variable, or via a shared credentials file if profile is specified.
shared_credentials_file str: This is the path to the shared credentials file. If this is not set and a profile is specified, ~/.aws/credentials will be used.
skip_credentials_validation bool: Skip the credentials validation via the STS API. Useful for AWS API implementations that do not have STS available or implemented.
skip_metadata_api_check bool: Skip the AWS Metadata API check. Useful for AWS API implementations that do not have a metadata API endpoint. Setting to true prevents Terraform from authenticating via the Metadata API. You may need to use other authentication methods like static credentials, configuration variables, or environment variables.
skip_requesting_account_id bool: Skip requesting the account ID. Useful for AWS API implementations that do not have the IAM, STS API, or metadata API.
token str: Session token for validating temporary credentials. Typically provided after successful identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit MFA code used to get temporary credentials. It can also be sourced from the AWS_SESSION_TOKEN environment variable.

region String: This is the AWS region. It must be provided, but it can also be sourced from the AWS_DEFAULT_REGION environment variables, or via a shared credentials file if profile is specified.
accessKey String: This is the AWS access key. It must be provided, but it can also be sourced from the AWS_ACCESS_KEY_ID environment variable, or via a shared credentials file if profile is specified.
assumeRole Property Map: Settings for making use of the AWS Assume Role functionality.
maxRetries Number: This is the maximum number of times an API call is retried, in the case where requests are being throttled or experiencing transient failures. The delay between the subsequent API calls increases exponentially. If omitted, the default value is 25.
profile String: This is the AWS profile name as set in the shared credentials file.
secretKey String: This is the AWS secret key. It must be provided, but it can also be sourced from the AWS_SECRET_ACCESS_KEY environment variable, or via a shared credentials file if profile is specified.
sharedCredentialsFile String: This is the path to the shared credentials file. If this is not set and a profile is specified, ~/.aws/credentials will be used.
skipCredentialsValidation Boolean: Skip the credentials validation via the STS API. Useful for AWS API implementations that do not have STS available or implemented.
skipMetadataApiCheck Boolean: Skip the AWS Metadata API check. Useful for AWS API implementations that do not have a metadata API endpoint. Setting to true prevents Terraform from authenticating via the Metadata API. You may need to use other authentication methods like static credentials, configuration variables, or environment variables.
skipRequestingAccountId Boolean: Skip requesting the account ID. Useful for AWS API implementations that do not have the IAM, STS API, or metadata API.
token String: Session token for validating temporary credentials. Typically provided after successful identity federation or Multi-Factor Authentication (MFA) login. With MFA login, this is the session token provided afterward, not the 6 digit MFA code used to get temporary credentials. It can also be sourced from the 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

DurationSeconds int
ExternalId string
Policy string
PolicyArns List<string>
RoleArn string
SessionName string
Tags Dictionary<string, string>
TransitiveTagKeys List<string>

DurationSeconds int
ExternalId string
Policy string
PolicyArns []string
RoleArn string
SessionName string
Tags map[string]string
TransitiveTagKeys []string

durationSeconds Integer
externalId String
policy String
policyArns List<String>
roleArn String
sessionName String
tags Map<String,String>
transitiveTagKeys List<String>

durationSeconds number
externalId string
policy string
policyArns string[]
roleArn string
sessionName string
tags {[key: string]: string}
transitiveTagKeys string[]

duration_seconds int
external_id str
policy str
policy_arns Sequence[str]
role_arn str
session_name str
tags Mapping[str, str]
transitive_tag_keys Sequence[str]

durationSeconds Number
externalId String
policy String
policyArns List<String>
roleArn String
sessionName String
tags Map<String>
transitiveTagKeys List<String>

Package Details

Repository: awscontroltower lbrlabs/pulumi-awscontroltower
License: Apache-2.0
Notes: This Pulumi package is based on the awscontroltower Terraform Provider.

AWS Control Tower v0.0.2 published on Friday, Oct 20, 2023 by lbrlabs

lbrlabs/pulumi-awscontroltower

awscontroltower.Provider

On this page

On this page

Create Provider Resource

Constructor syntax

Parameters

Provider Resource Properties

Inputs

Outputs

Supporting Types

ProviderAssumeRole, ProviderAssumeRoleArgs

Package Details

On this page

On this page