amplify

package
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 25, 2024 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	AppAutoBranchCreationConfigStageExperimental = AppAutoBranchCreationConfigStage("EXPERIMENTAL")
	AppAutoBranchCreationConfigStageBeta         = AppAutoBranchCreationConfigStage("BETA")
	AppAutoBranchCreationConfigStagePullRequest  = AppAutoBranchCreationConfigStage("PULL_REQUEST")
	AppAutoBranchCreationConfigStageProduction   = AppAutoBranchCreationConfigStage("PRODUCTION")
	AppAutoBranchCreationConfigStageDevelopment  = AppAutoBranchCreationConfigStage("DEVELOPMENT")
)
View Source 
const (
	AppCacheConfigTypeAmplifyManaged          = AppCacheConfigType("AMPLIFY_MANAGED")
	AppCacheConfigTypeAmplifyManagedNoCookies = AppCacheConfigType("AMPLIFY_MANAGED_NO_COOKIES")
)
View Source 
const (
	AppPlatformWeb        = AppPlatform("WEB")
	AppPlatformWebDynamic = AppPlatform("WEB_DYNAMIC")
	AppPlatformWebCompute = AppPlatform("WEB_COMPUTE")
)
View Source 
const (
	BranchStageExperimental = BranchStage("EXPERIMENTAL")
	BranchStageBeta         = BranchStage("BETA")
	BranchStagePullRequest  = BranchStage("PULL_REQUEST")
	BranchStageProduction   = BranchStage("PRODUCTION")
	BranchStageDevelopment  = BranchStage("DEVELOPMENT")
)
View Source 
const (
	DomainCertificateCertificateTypeAmplifyManaged = DomainCertificateCertificateType("AMPLIFY_MANAGED")
	DomainCertificateCertificateTypeCustom         = DomainCertificateCertificateType("CUSTOM")
)
View Source 
const (
	DomainCertificateSettingsCertificateTypeAmplifyManaged = DomainCertificateSettingsCertificateType("AMPLIFY_MANAGED")
	DomainCertificateSettingsCertificateTypeCustom         = DomainCertificateSettingsCertificateType("CUSTOM")
)

Variables

This section is empty.

Functions

This section is empty.

Types

type App 

type App struct {
	pulumi.CustomResourceState

	// The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
	//
	// Use `AccessToken` for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use `OauthToken` .
	//
	// You must specify either `AccessToken` or `OauthToken` when you create a new app.
	//
	// Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* .
	AccessToken pulumi.StringPtrOutput `pulumi:"accessToken"`
	// Unique Id for the Amplify App.
	AppId pulumi.StringOutput `pulumi:"appId"`
	// Name for the Amplify App.
	AppName pulumi.StringOutput `pulumi:"appName"`
	// ARN for the Amplify App.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Sets the configuration for your automatic branch creation.
	AutoBranchCreationConfig AppAutoBranchCreationConfigPtrOutput `pulumi:"autoBranchCreationConfig"`
	// The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format `user:password` .
	BasicAuthConfig AppBasicAuthConfigPtrOutput `pulumi:"basicAuthConfig"`
	// The build specification (build spec) for an Amplify app.
	BuildSpec pulumi.StringPtrOutput `pulumi:"buildSpec"`
	// The cache configuration for the Amplify app. If you don't specify the cache configuration `type` , Amplify uses the default `AMPLIFY_MANAGED` setting.
	CacheConfig AppCacheConfigPtrOutput `pulumi:"cacheConfig"`
	// The custom HTTP headers for an Amplify app.
	CustomHeaders pulumi.StringPtrOutput `pulumi:"customHeaders"`
	// The custom rewrite and redirect rules for an Amplify app.
	CustomRules AppCustomRuleArrayOutput `pulumi:"customRules"`
	// Default domain for the Amplify App.
	DefaultDomain pulumi.StringOutput `pulumi:"defaultDomain"`
	// The description of the Amplify app.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
	EnableBranchAutoDeletion pulumi.BoolPtrOutput `pulumi:"enableBranchAutoDeletion"`
	// The environment variables for the Amplify app.
	//
	// For a list of the environment variables that are accessible to Amplify by default, see [Amplify Environment variables](https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html) in the *Amplify Hosting User Guide* .
	EnvironmentVariables AppEnvironmentVariableArrayOutput `pulumi:"environmentVariables"`
	// AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
	IamServiceRole pulumi.StringPtrOutput `pulumi:"iamServiceRole"`
	// The name of the Amplify app.
	Name pulumi.StringOutput `pulumi:"name"`
	// The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.
	//
	// Use `OauthToken` for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use `AccessToken` .
	//
	// You must specify either `OauthToken` or `AccessToken` when you create a new app.
	//
	// Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* .
	OauthToken pulumi.StringPtrOutput `pulumi:"oauthToken"`
	// The platform for the Amplify app. For a static app, set the platform type to `WEB` . For a dynamic server-side rendered (SSR) app, set the platform type to `WEB_COMPUTE` . For an app requiring Amplify Hosting's original SSR support only, set the platform type to `WEB_DYNAMIC` .
	//
	// If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to `WEB_COMPUTE` and set the artifacts `baseDirectory` to `.next` in the application's build settings. For an example of the build specification settings, see [Amplify build settings for a Next.js 14 SSG application](https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14) in the *Amplify Hosting User Guide* .
	Platform AppPlatformPtrOutput `pulumi:"platform"`
	// The Git repository for the Amplify app.
	Repository pulumi.StringPtrOutput `pulumi:"repository"`
	// The tag for an Amplify app.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.

func GetApp 

func GetApp(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *AppState, opts ...pulumi.ResourceOption) (*App, error)

GetApp gets an existing App resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewApp 

func NewApp(ctx *pulumi.Context,
	name string, args *AppArgs, opts ...pulumi.ResourceOption) (*App, error)

NewApp registers a new resource with the given unique name, arguments, and options.

func (*App) ElementType 

func (*App) ElementType() reflect.Type

func (*App) ToAppOutput 

func (i *App) ToAppOutput() AppOutput

func (*App) ToAppOutputWithContext 

func (i *App) ToAppOutputWithContext(ctx context.Context) AppOutput

type AppArgs 

type AppArgs struct {
	// The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.
	//
	// Use `AccessToken` for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use `OauthToken` .
	//
	// You must specify either `AccessToken` or `OauthToken` when you create a new app.
	//
	// Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* .
	AccessToken pulumi.StringPtrInput
	// Sets the configuration for your automatic branch creation.
	AutoBranchCreationConfig AppAutoBranchCreationConfigPtrInput
	// The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format `user:password` .
	BasicAuthConfig AppBasicAuthConfigPtrInput
	// The build specification (build spec) for an Amplify app.
	BuildSpec pulumi.StringPtrInput
	// The cache configuration for the Amplify app. If you don't specify the cache configuration `type` , Amplify uses the default `AMPLIFY_MANAGED` setting.
	CacheConfig AppCacheConfigPtrInput
	// The custom HTTP headers for an Amplify app.
	CustomHeaders pulumi.StringPtrInput
	// The custom rewrite and redirect rules for an Amplify app.
	CustomRules AppCustomRuleArrayInput
	// The description of the Amplify app.
	Description pulumi.StringPtrInput
	// Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
	EnableBranchAutoDeletion pulumi.BoolPtrInput
	// The environment variables for the Amplify app.
	//
	// For a list of the environment variables that are accessible to Amplify by default, see [Amplify Environment variables](https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html) in the *Amplify Hosting User Guide* .
	EnvironmentVariables AppEnvironmentVariableArrayInput
	// AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
	IamServiceRole pulumi.StringPtrInput
	// The name of the Amplify app.
	Name pulumi.StringPtrInput
	// The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.
	//
	// Use `OauthToken` for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use `AccessToken` .
	//
	// You must specify either `OauthToken` or `AccessToken` when you create a new app.
	//
	// Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* .
	OauthToken pulumi.StringPtrInput
	// The platform for the Amplify app. For a static app, set the platform type to `WEB` . For a dynamic server-side rendered (SSR) app, set the platform type to `WEB_COMPUTE` . For an app requiring Amplify Hosting's original SSR support only, set the platform type to `WEB_DYNAMIC` .
	//
	// If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to `WEB_COMPUTE` and set the artifacts `baseDirectory` to `.next` in the application's build settings. For an example of the build specification settings, see [Amplify build settings for a Next.js 14 SSG application](https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14) in the *Amplify Hosting User Guide* .
	Platform AppPlatformPtrInput
	// The Git repository for the Amplify app.
	Repository pulumi.StringPtrInput
	// The tag for an Amplify app.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a App resource.

func (AppArgs) ElementType 

func (AppArgs) ElementType() reflect.Type

type AppAutoBranchCreationConfig 

type AppAutoBranchCreationConfig struct {
	// Automated branch creation glob patterns for the Amplify app.
	AutoBranchCreationPatterns []string `pulumi:"autoBranchCreationPatterns"`
	// Sets password protection for your auto created branch.
	BasicAuthConfig *AppBasicAuthConfig `pulumi:"basicAuthConfig"`
	// The build specification (build spec) for the autocreated branch.
	BuildSpec *string `pulumi:"buildSpec"`
	// Enables automated branch creation for the Amplify app.
	EnableAutoBranchCreation *bool `pulumi:"enableAutoBranchCreation"`
	// Enables auto building for the auto created branch.
	EnableAutoBuild *bool `pulumi:"enableAutoBuild"`
	// Enables performance mode for the branch.
	//
	// Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
	EnablePerformanceMode *bool `pulumi:"enablePerformanceMode"`
	// Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.
	//
	// To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.
	//
	// For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .
	EnablePullRequestPreview *bool `pulumi:"enablePullRequestPreview"`
	// The environment variables for the autocreated branch.
	EnvironmentVariables []AppEnvironmentVariable `pulumi:"environmentVariables"`
	// The framework for the autocreated branch.
	Framework *string `pulumi:"framework"`
	// If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI.
	//
	// To enable pull request previews, set the `EnablePullRequestPreview` property to `true` .
	//
	// If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed.
	//
	// For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .
	PullRequestEnvironmentName *string `pulumi:"pullRequestEnvironmentName"`
	// Stage for the auto created branch.
	Stage *AppAutoBranchCreationConfigStage `pulumi:"stage"`
}

type AppAutoBranchCreationConfigArgs 

type AppAutoBranchCreationConfigArgs struct {
	// Automated branch creation glob patterns for the Amplify app.
	AutoBranchCreationPatterns pulumi.StringArrayInput `pulumi:"autoBranchCreationPatterns"`
	// Sets password protection for your auto created branch.
	BasicAuthConfig AppBasicAuthConfigPtrInput `pulumi:"basicAuthConfig"`
	// The build specification (build spec) for the autocreated branch.
	BuildSpec pulumi.StringPtrInput `pulumi:"buildSpec"`
	// Enables automated branch creation for the Amplify app.
	EnableAutoBranchCreation pulumi.BoolPtrInput `pulumi:"enableAutoBranchCreation"`
	// Enables auto building for the auto created branch.
	EnableAutoBuild pulumi.BoolPtrInput `pulumi:"enableAutoBuild"`
	// Enables performance mode for the branch.
	//
	// Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
	EnablePerformanceMode pulumi.BoolPtrInput `pulumi:"enablePerformanceMode"`
	// Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.
	//
	// To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.
	//
	// For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .
	EnablePullRequestPreview pulumi.BoolPtrInput `pulumi:"enablePullRequestPreview"`
	// The environment variables for the autocreated branch.
	EnvironmentVariables AppEnvironmentVariableArrayInput `pulumi:"environmentVariables"`
	// The framework for the autocreated branch.
	Framework pulumi.StringPtrInput `pulumi:"framework"`
	// If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI.
	//
	// To enable pull request previews, set the `EnablePullRequestPreview` property to `true` .
	//
	// If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed.
	//
	// For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .
	PullRequestEnvironmentName pulumi.StringPtrInput `pulumi:"pullRequestEnvironmentName"`
	// Stage for the auto created branch.
	Stage AppAutoBranchCreationConfigStagePtrInput `pulumi:"stage"`
}

func (AppAutoBranchCreationConfigArgs) ElementType 

func (AppAutoBranchCreationConfigArgs) ElementType() reflect.Type

func (AppAutoBranchCreationConfigArgs) ToAppAutoBranchCreationConfigOutput 

func (i AppAutoBranchCreationConfigArgs) ToAppAutoBranchCreationConfigOutput() AppAutoBranchCreationConfigOutput

func (AppAutoBranchCreationConfigArgs) ToAppAutoBranchCreationConfigOutputWithContext 

func (i AppAutoBranchCreationConfigArgs) ToAppAutoBranchCreationConfigOutputWithContext(ctx context.Context) AppAutoBranchCreationConfigOutput

func (AppAutoBranchCreationConfigArgs) ToAppAutoBranchCreationConfigPtrOutput 

func (i AppAutoBranchCreationConfigArgs) ToAppAutoBranchCreationConfigPtrOutput() AppAutoBranchCreationConfigPtrOutput

func (AppAutoBranchCreationConfigArgs) ToAppAutoBranchCreationConfigPtrOutputWithContext 

func (i AppAutoBranchCreationConfigArgs) ToAppAutoBranchCreationConfigPtrOutputWithContext(ctx context.Context) AppAutoBranchCreationConfigPtrOutput

type AppAutoBranchCreationConfigInput 

type AppAutoBranchCreationConfigInput interface {
	pulumi.Input

	ToAppAutoBranchCreationConfigOutput() AppAutoBranchCreationConfigOutput
	ToAppAutoBranchCreationConfigOutputWithContext(context.Context) AppAutoBranchCreationConfigOutput
}

AppAutoBranchCreationConfigInput is an input type that accepts AppAutoBranchCreationConfigArgs and AppAutoBranchCreationConfigOutput values. You can construct a concrete instance of `AppAutoBranchCreationConfigInput` via: 

AppAutoBranchCreationConfigArgs{...}

type AppAutoBranchCreationConfigOutput 

type AppAutoBranchCreationConfigOutput struct{ *pulumi.OutputState }

func (AppAutoBranchCreationConfigOutput) AutoBranchCreationPatterns 

func (o AppAutoBranchCreationConfigOutput) AutoBranchCreationPatterns() pulumi.StringArrayOutput

Automated branch creation glob patterns for the Amplify app.

func (AppAutoBranchCreationConfigOutput) BasicAuthConfig 

func (o AppAutoBranchCreationConfigOutput) BasicAuthConfig() AppBasicAuthConfigPtrOutput

Sets password protection for your auto created branch.

func (AppAutoBranchCreationConfigOutput) BuildSpec 

func (o AppAutoBranchCreationConfigOutput) BuildSpec() pulumi.StringPtrOutput

The build specification (build spec) for the autocreated branch.

func (AppAutoBranchCreationConfigOutput) ElementType 

func (AppAutoBranchCreationConfigOutput) ElementType() reflect.Type

func (AppAutoBranchCreationConfigOutput) EnableAutoBranchCreation 

func (o AppAutoBranchCreationConfigOutput) EnableAutoBranchCreation() pulumi.BoolPtrOutput

Enables automated branch creation for the Amplify app.

func (AppAutoBranchCreationConfigOutput) EnableAutoBuild 

func (o AppAutoBranchCreationConfigOutput) EnableAutoBuild() pulumi.BoolPtrOutput

Enables auto building for the auto created branch.

func (AppAutoBranchCreationConfigOutput) EnablePerformanceMode 

func (o AppAutoBranchCreationConfigOutput) EnablePerformanceMode() pulumi.BoolPtrOutput

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

func (AppAutoBranchCreationConfigOutput) EnablePullRequestPreview 

func (o AppAutoBranchCreationConfigOutput) EnablePullRequestPreview() pulumi.BoolPtrOutput

Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.

To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.

For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .

func (AppAutoBranchCreationConfigOutput) EnvironmentVariables 

func (o AppAutoBranchCreationConfigOutput) EnvironmentVariables() AppEnvironmentVariableArrayOutput

The environment variables for the autocreated branch.

func (AppAutoBranchCreationConfigOutput) Framework added in v0.41.0 

func (o AppAutoBranchCreationConfigOutput) Framework() pulumi.StringPtrOutput

The framework for the autocreated branch.

func (AppAutoBranchCreationConfigOutput) PullRequestEnvironmentName 

func (o AppAutoBranchCreationConfigOutput) PullRequestEnvironmentName() pulumi.StringPtrOutput

If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI.

To enable pull request previews, set the `EnablePullRequestPreview` property to `true` .

If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed.

For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .

func (AppAutoBranchCreationConfigOutput) Stage 

func (o AppAutoBranchCreationConfigOutput) Stage() AppAutoBranchCreationConfigStagePtrOutput

Stage for the auto created branch.

func (AppAutoBranchCreationConfigOutput) ToAppAutoBranchCreationConfigOutput 

func (o AppAutoBranchCreationConfigOutput) ToAppAutoBranchCreationConfigOutput() AppAutoBranchCreationConfigOutput

func (AppAutoBranchCreationConfigOutput) ToAppAutoBranchCreationConfigOutputWithContext 

func (o AppAutoBranchCreationConfigOutput) ToAppAutoBranchCreationConfigOutputWithContext(ctx context.Context) AppAutoBranchCreationConfigOutput

func (AppAutoBranchCreationConfigOutput) ToAppAutoBranchCreationConfigPtrOutput 

func (o AppAutoBranchCreationConfigOutput) ToAppAutoBranchCreationConfigPtrOutput() AppAutoBranchCreationConfigPtrOutput

func (AppAutoBranchCreationConfigOutput) ToAppAutoBranchCreationConfigPtrOutputWithContext 

func (o AppAutoBranchCreationConfigOutput) ToAppAutoBranchCreationConfigPtrOutputWithContext(ctx context.Context) AppAutoBranchCreationConfigPtrOutput

type AppAutoBranchCreationConfigPtrInput 

type AppAutoBranchCreationConfigPtrInput interface {
	pulumi.Input

	ToAppAutoBranchCreationConfigPtrOutput() AppAutoBranchCreationConfigPtrOutput
	ToAppAutoBranchCreationConfigPtrOutputWithContext(context.Context) AppAutoBranchCreationConfigPtrOutput
}

AppAutoBranchCreationConfigPtrInput is an input type that accepts AppAutoBranchCreationConfigArgs, AppAutoBranchCreationConfigPtr and AppAutoBranchCreationConfigPtrOutput values. You can construct a concrete instance of `AppAutoBranchCreationConfigPtrInput` via: 

        AppAutoBranchCreationConfigArgs{...}

or:

        nil

func AppAutoBranchCreationConfigPtr 

func AppAutoBranchCreationConfigPtr(v *AppAutoBranchCreationConfigArgs) AppAutoBranchCreationConfigPtrInput

type AppAutoBranchCreationConfigPtrOutput 

type AppAutoBranchCreationConfigPtrOutput struct{ *pulumi.OutputState }

func (AppAutoBranchCreationConfigPtrOutput) AutoBranchCreationPatterns 

func (o AppAutoBranchCreationConfigPtrOutput) AutoBranchCreationPatterns() pulumi.StringArrayOutput

Automated branch creation glob patterns for the Amplify app.

func (AppAutoBranchCreationConfigPtrOutput) BasicAuthConfig 

func (o AppAutoBranchCreationConfigPtrOutput) BasicAuthConfig() AppBasicAuthConfigPtrOutput

Sets password protection for your auto created branch.

func (AppAutoBranchCreationConfigPtrOutput) BuildSpec 

func (o AppAutoBranchCreationConfigPtrOutput) BuildSpec() pulumi.StringPtrOutput

The build specification (build spec) for the autocreated branch.

func (AppAutoBranchCreationConfigPtrOutput) Elem 

func (o AppAutoBranchCreationConfigPtrOutput) Elem() AppAutoBranchCreationConfigOutput

func (AppAutoBranchCreationConfigPtrOutput) ElementType 

func (AppAutoBranchCreationConfigPtrOutput) ElementType() reflect.Type

func (AppAutoBranchCreationConfigPtrOutput) EnableAutoBranchCreation 

func (o AppAutoBranchCreationConfigPtrOutput) EnableAutoBranchCreation() pulumi.BoolPtrOutput

Enables automated branch creation for the Amplify app.

func (AppAutoBranchCreationConfigPtrOutput) EnableAutoBuild 

func (o AppAutoBranchCreationConfigPtrOutput) EnableAutoBuild() pulumi.BoolPtrOutput

Enables auto building for the auto created branch.

func (AppAutoBranchCreationConfigPtrOutput) EnablePerformanceMode 

func (o AppAutoBranchCreationConfigPtrOutput) EnablePerformanceMode() pulumi.BoolPtrOutput

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

func (AppAutoBranchCreationConfigPtrOutput) EnablePullRequestPreview 

func (o AppAutoBranchCreationConfigPtrOutput) EnablePullRequestPreview() pulumi.BoolPtrOutput

Sets whether pull request previews are enabled for each branch that Amplify Hosting automatically creates for your app. Amplify creates previews by deploying your app to a unique URL whenever a pull request is opened for the branch. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.

To provide backend support for your preview, Amplify Hosting automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.

For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .

func (AppAutoBranchCreationConfigPtrOutput) EnvironmentVariables 

func (o AppAutoBranchCreationConfigPtrOutput) EnvironmentVariables() AppEnvironmentVariableArrayOutput

The environment variables for the autocreated branch.

func (AppAutoBranchCreationConfigPtrOutput) Framework added in v0.41.0 

func (o AppAutoBranchCreationConfigPtrOutput) Framework() pulumi.StringPtrOutput

The framework for the autocreated branch.

func (AppAutoBranchCreationConfigPtrOutput) PullRequestEnvironmentName 

func (o AppAutoBranchCreationConfigPtrOutput) PullRequestEnvironmentName() pulumi.StringPtrOutput

If pull request previews are enabled, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI.

To enable pull request previews, set the `EnablePullRequestPreview` property to `true` .

If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify deletes this environment when the pull request is closed.

For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .

func (AppAutoBranchCreationConfigPtrOutput) Stage 

func (o AppAutoBranchCreationConfigPtrOutput) Stage() AppAutoBranchCreationConfigStagePtrOutput

Stage for the auto created branch.

func (AppAutoBranchCreationConfigPtrOutput) ToAppAutoBranchCreationConfigPtrOutput 

func (o AppAutoBranchCreationConfigPtrOutput) ToAppAutoBranchCreationConfigPtrOutput() AppAutoBranchCreationConfigPtrOutput

func (AppAutoBranchCreationConfigPtrOutput) ToAppAutoBranchCreationConfigPtrOutputWithContext 

func (o AppAutoBranchCreationConfigPtrOutput) ToAppAutoBranchCreationConfigPtrOutputWithContext(ctx context.Context) AppAutoBranchCreationConfigPtrOutput

type AppAutoBranchCreationConfigStage 

type AppAutoBranchCreationConfigStage string

Stage for the auto created branch.

func (AppAutoBranchCreationConfigStage) ElementType 

func (AppAutoBranchCreationConfigStage) ElementType() reflect.Type

func (AppAutoBranchCreationConfigStage) ToAppAutoBranchCreationConfigStageOutput 

func (e AppAutoBranchCreationConfigStage) ToAppAutoBranchCreationConfigStageOutput() AppAutoBranchCreationConfigStageOutput

func (AppAutoBranchCreationConfigStage) ToAppAutoBranchCreationConfigStageOutputWithContext 

func (e AppAutoBranchCreationConfigStage) ToAppAutoBranchCreationConfigStageOutputWithContext(ctx context.Context) AppAutoBranchCreationConfigStageOutput

func (AppAutoBranchCreationConfigStage) ToAppAutoBranchCreationConfigStagePtrOutput 

func (e AppAutoBranchCreationConfigStage) ToAppAutoBranchCreationConfigStagePtrOutput() AppAutoBranchCreationConfigStagePtrOutput

func (AppAutoBranchCreationConfigStage) ToAppAutoBranchCreationConfigStagePtrOutputWithContext 

func (e AppAutoBranchCreationConfigStage) ToAppAutoBranchCreationConfigStagePtrOutputWithContext(ctx context.Context) AppAutoBranchCreationConfigStagePtrOutput

func (AppAutoBranchCreationConfigStage) ToStringOutput 

func (e AppAutoBranchCreationConfigStage) ToStringOutput() pulumi.StringOutput

func (AppAutoBranchCreationConfigStage) ToStringOutputWithContext 

func (e AppAutoBranchCreationConfigStage) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (AppAutoBranchCreationConfigStage) ToStringPtrOutput 

func (e AppAutoBranchCreationConfigStage) ToStringPtrOutput() pulumi.StringPtrOutput

func (AppAutoBranchCreationConfigStage) ToStringPtrOutputWithContext 

func (e AppAutoBranchCreationConfigStage) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AppAutoBranchCreationConfigStageInput 

type AppAutoBranchCreationConfigStageInput interface {
	pulumi.Input

	ToAppAutoBranchCreationConfigStageOutput() AppAutoBranchCreationConfigStageOutput
	ToAppAutoBranchCreationConfigStageOutputWithContext(context.Context) AppAutoBranchCreationConfigStageOutput
}

AppAutoBranchCreationConfigStageInput is an input type that accepts values of the AppAutoBranchCreationConfigStage enum A concrete instance of `AppAutoBranchCreationConfigStageInput` can be one of the following: 

AppAutoBranchCreationConfigStageExperimental
AppAutoBranchCreationConfigStageBeta
AppAutoBranchCreationConfigStagePullRequest
AppAutoBranchCreationConfigStageProduction
AppAutoBranchCreationConfigStageDevelopment

type AppAutoBranchCreationConfigStageOutput 

type AppAutoBranchCreationConfigStageOutput struct{ *pulumi.OutputState }

func (AppAutoBranchCreationConfigStageOutput) ElementType 

func (AppAutoBranchCreationConfigStageOutput) ElementType() reflect.Type

func (AppAutoBranchCreationConfigStageOutput) ToAppAutoBranchCreationConfigStageOutput 

func (o AppAutoBranchCreationConfigStageOutput) ToAppAutoBranchCreationConfigStageOutput() AppAutoBranchCreationConfigStageOutput

func (AppAutoBranchCreationConfigStageOutput) ToAppAutoBranchCreationConfigStageOutputWithContext 

func (o AppAutoBranchCreationConfigStageOutput) ToAppAutoBranchCreationConfigStageOutputWithContext(ctx context.Context) AppAutoBranchCreationConfigStageOutput

func (AppAutoBranchCreationConfigStageOutput) ToAppAutoBranchCreationConfigStagePtrOutput 

func (o AppAutoBranchCreationConfigStageOutput) ToAppAutoBranchCreationConfigStagePtrOutput() AppAutoBranchCreationConfigStagePtrOutput

func (AppAutoBranchCreationConfigStageOutput) ToAppAutoBranchCreationConfigStagePtrOutputWithContext 

func (o AppAutoBranchCreationConfigStageOutput) ToAppAutoBranchCreationConfigStagePtrOutputWithContext(ctx context.Context) AppAutoBranchCreationConfigStagePtrOutput

func (AppAutoBranchCreationConfigStageOutput) ToStringOutput 

func (o AppAutoBranchCreationConfigStageOutput) ToStringOutput() pulumi.StringOutput

func (AppAutoBranchCreationConfigStageOutput) ToStringOutputWithContext 

func (o AppAutoBranchCreationConfigStageOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (AppAutoBranchCreationConfigStageOutput) ToStringPtrOutput 

func (o AppAutoBranchCreationConfigStageOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AppAutoBranchCreationConfigStageOutput) ToStringPtrOutputWithContext 

func (o AppAutoBranchCreationConfigStageOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AppAutoBranchCreationConfigStagePtrInput 

type AppAutoBranchCreationConfigStagePtrInput interface {
	pulumi.Input

	ToAppAutoBranchCreationConfigStagePtrOutput() AppAutoBranchCreationConfigStagePtrOutput
	ToAppAutoBranchCreationConfigStagePtrOutputWithContext(context.Context) AppAutoBranchCreationConfigStagePtrOutput
}

func AppAutoBranchCreationConfigStagePtr 

func AppAutoBranchCreationConfigStagePtr(v string) AppAutoBranchCreationConfigStagePtrInput

type AppAutoBranchCreationConfigStagePtrOutput 

type AppAutoBranchCreationConfigStagePtrOutput struct{ *pulumi.OutputState }

func (AppAutoBranchCreationConfigStagePtrOutput) Elem 

func (o AppAutoBranchCreationConfigStagePtrOutput) Elem() AppAutoBranchCreationConfigStageOutput

func (AppAutoBranchCreationConfigStagePtrOutput) ElementType 

func (AppAutoBranchCreationConfigStagePtrOutput) ElementType() reflect.Type

func (AppAutoBranchCreationConfigStagePtrOutput) ToAppAutoBranchCreationConfigStagePtrOutput 

func (o AppAutoBranchCreationConfigStagePtrOutput) ToAppAutoBranchCreationConfigStagePtrOutput() AppAutoBranchCreationConfigStagePtrOutput

func (AppAutoBranchCreationConfigStagePtrOutput) ToAppAutoBranchCreationConfigStagePtrOutputWithContext 

func (o AppAutoBranchCreationConfigStagePtrOutput) ToAppAutoBranchCreationConfigStagePtrOutputWithContext(ctx context.Context) AppAutoBranchCreationConfigStagePtrOutput

func (AppAutoBranchCreationConfigStagePtrOutput) ToStringPtrOutput 

func (o AppAutoBranchCreationConfigStagePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AppAutoBranchCreationConfigStagePtrOutput) ToStringPtrOutputWithContext 

func (o AppAutoBranchCreationConfigStagePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AppBasicAuthConfig 

type AppBasicAuthConfig struct {
	// Enables basic authorization for the Amplify app's branches.
	EnableBasicAuth *bool `pulumi:"enableBasicAuth"`
	// The password for basic authorization.
	Password *string `pulumi:"password"`
	// The user name for basic authorization.
	Username *string `pulumi:"username"`
}

type AppBasicAuthConfigArgs 

type AppBasicAuthConfigArgs struct {
	// Enables basic authorization for the Amplify app's branches.
	EnableBasicAuth pulumi.BoolPtrInput `pulumi:"enableBasicAuth"`
	// The password for basic authorization.
	Password pulumi.StringPtrInput `pulumi:"password"`
	// The user name for basic authorization.
	Username pulumi.StringPtrInput `pulumi:"username"`
}

func (AppBasicAuthConfigArgs) ElementType 

func (AppBasicAuthConfigArgs) ElementType() reflect.Type

func (AppBasicAuthConfigArgs) ToAppBasicAuthConfigOutput 

func (i AppBasicAuthConfigArgs) ToAppBasicAuthConfigOutput() AppBasicAuthConfigOutput

func (AppBasicAuthConfigArgs) ToAppBasicAuthConfigOutputWithContext 

func (i AppBasicAuthConfigArgs) ToAppBasicAuthConfigOutputWithContext(ctx context.Context) AppBasicAuthConfigOutput

func (AppBasicAuthConfigArgs) ToAppBasicAuthConfigPtrOutput 

func (i AppBasicAuthConfigArgs) ToAppBasicAuthConfigPtrOutput() AppBasicAuthConfigPtrOutput

func (AppBasicAuthConfigArgs) ToAppBasicAuthConfigPtrOutputWithContext 

func (i AppBasicAuthConfigArgs) ToAppBasicAuthConfigPtrOutputWithContext(ctx context.Context) AppBasicAuthConfigPtrOutput

type AppBasicAuthConfigInput 

type AppBasicAuthConfigInput interface {
	pulumi.Input

	ToAppBasicAuthConfigOutput() AppBasicAuthConfigOutput
	ToAppBasicAuthConfigOutputWithContext(context.Context) AppBasicAuthConfigOutput
}

AppBasicAuthConfigInput is an input type that accepts AppBasicAuthConfigArgs and AppBasicAuthConfigOutput values. You can construct a concrete instance of `AppBasicAuthConfigInput` via: 

AppBasicAuthConfigArgs{...}

type AppBasicAuthConfigOutput 

type AppBasicAuthConfigOutput struct{ *pulumi.OutputState }

func (AppBasicAuthConfigOutput) ElementType 

func (AppBasicAuthConfigOutput) ElementType() reflect.Type

func (AppBasicAuthConfigOutput) EnableBasicAuth 

func (o AppBasicAuthConfigOutput) EnableBasicAuth() pulumi.BoolPtrOutput

Enables basic authorization for the Amplify app's branches.

func (AppBasicAuthConfigOutput) Password 

func (o AppBasicAuthConfigOutput) Password() pulumi.StringPtrOutput

The password for basic authorization.

func (AppBasicAuthConfigOutput) ToAppBasicAuthConfigOutput 

func (o AppBasicAuthConfigOutput) ToAppBasicAuthConfigOutput() AppBasicAuthConfigOutput

func (AppBasicAuthConfigOutput) ToAppBasicAuthConfigOutputWithContext 

func (o AppBasicAuthConfigOutput) ToAppBasicAuthConfigOutputWithContext(ctx context.Context) AppBasicAuthConfigOutput

func (AppBasicAuthConfigOutput) ToAppBasicAuthConfigPtrOutput 

func (o AppBasicAuthConfigOutput) ToAppBasicAuthConfigPtrOutput() AppBasicAuthConfigPtrOutput

func (AppBasicAuthConfigOutput) ToAppBasicAuthConfigPtrOutputWithContext 

func (o AppBasicAuthConfigOutput) ToAppBasicAuthConfigPtrOutputWithContext(ctx context.Context) AppBasicAuthConfigPtrOutput

func (AppBasicAuthConfigOutput) Username 

func (o AppBasicAuthConfigOutput) Username() pulumi.StringPtrOutput

The user name for basic authorization.

type AppBasicAuthConfigPtrInput 

type AppBasicAuthConfigPtrInput interface {
	pulumi.Input

	ToAppBasicAuthConfigPtrOutput() AppBasicAuthConfigPtrOutput
	ToAppBasicAuthConfigPtrOutputWithContext(context.Context) AppBasicAuthConfigPtrOutput
}

AppBasicAuthConfigPtrInput is an input type that accepts AppBasicAuthConfigArgs, AppBasicAuthConfigPtr and AppBasicAuthConfigPtrOutput values. You can construct a concrete instance of `AppBasicAuthConfigPtrInput` via: 

        AppBasicAuthConfigArgs{...}

or:

        nil

func AppBasicAuthConfigPtr 

func AppBasicAuthConfigPtr(v *AppBasicAuthConfigArgs) AppBasicAuthConfigPtrInput

type AppBasicAuthConfigPtrOutput 

type AppBasicAuthConfigPtrOutput struct{ *pulumi.OutputState }

func (AppBasicAuthConfigPtrOutput) Elem 

func (o AppBasicAuthConfigPtrOutput) Elem() AppBasicAuthConfigOutput

func (AppBasicAuthConfigPtrOutput) ElementType 

func (AppBasicAuthConfigPtrOutput) ElementType() reflect.Type

func (AppBasicAuthConfigPtrOutput) EnableBasicAuth 

func (o AppBasicAuthConfigPtrOutput) EnableBasicAuth() pulumi.BoolPtrOutput

Enables basic authorization for the Amplify app's branches.

func (AppBasicAuthConfigPtrOutput) Password 

func (o AppBasicAuthConfigPtrOutput) Password() pulumi.StringPtrOutput

The password for basic authorization.

func (AppBasicAuthConfigPtrOutput) ToAppBasicAuthConfigPtrOutput 

func (o AppBasicAuthConfigPtrOutput) ToAppBasicAuthConfigPtrOutput() AppBasicAuthConfigPtrOutput

func (AppBasicAuthConfigPtrOutput) ToAppBasicAuthConfigPtrOutputWithContext 

func (o AppBasicAuthConfigPtrOutput) ToAppBasicAuthConfigPtrOutputWithContext(ctx context.Context) AppBasicAuthConfigPtrOutput

func (AppBasicAuthConfigPtrOutput) Username 

func (o AppBasicAuthConfigPtrOutput) Username() pulumi.StringPtrOutput

The user name for basic authorization.

type AppCacheConfig added in v0.122.0 

type AppCacheConfig struct {
	// The type of cache configuration to use for an Amplify app.
	//
	// The `AMPLIFY_MANAGED` cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.
	//
	// The `AMPLIFY_MANAGED_NO_COOKIES` cache configuration type is the same as `AMPLIFY_MANAGED` , except that it excludes all cookies from the cache key.
	Type *AppCacheConfigType `pulumi:"type"`
}

type AppCacheConfigArgs added in v0.122.0 

type AppCacheConfigArgs struct {
	// The type of cache configuration to use for an Amplify app.
	//
	// The `AMPLIFY_MANAGED` cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.
	//
	// The `AMPLIFY_MANAGED_NO_COOKIES` cache configuration type is the same as `AMPLIFY_MANAGED` , except that it excludes all cookies from the cache key.
	Type AppCacheConfigTypePtrInput `pulumi:"type"`
}

func (AppCacheConfigArgs) ElementType added in v0.122.0 

func (AppCacheConfigArgs) ElementType() reflect.Type

func (AppCacheConfigArgs) ToAppCacheConfigOutput added in v0.122.0 

func (i AppCacheConfigArgs) ToAppCacheConfigOutput() AppCacheConfigOutput

func (AppCacheConfigArgs) ToAppCacheConfigOutputWithContext added in v0.122.0 

func (i AppCacheConfigArgs) ToAppCacheConfigOutputWithContext(ctx context.Context) AppCacheConfigOutput

func (AppCacheConfigArgs) ToAppCacheConfigPtrOutput added in v0.122.0 

func (i AppCacheConfigArgs) ToAppCacheConfigPtrOutput() AppCacheConfigPtrOutput

func (AppCacheConfigArgs) ToAppCacheConfigPtrOutputWithContext added in v0.122.0 

func (i AppCacheConfigArgs) ToAppCacheConfigPtrOutputWithContext(ctx context.Context) AppCacheConfigPtrOutput

type AppCacheConfigInput added in v0.122.0 

type AppCacheConfigInput interface {
	pulumi.Input

	ToAppCacheConfigOutput() AppCacheConfigOutput
	ToAppCacheConfigOutputWithContext(context.Context) AppCacheConfigOutput
}

AppCacheConfigInput is an input type that accepts AppCacheConfigArgs and AppCacheConfigOutput values. You can construct a concrete instance of `AppCacheConfigInput` via: 

AppCacheConfigArgs{...}

type AppCacheConfigOutput added in v0.122.0 

type AppCacheConfigOutput struct{ *pulumi.OutputState }

func (AppCacheConfigOutput) ElementType added in v0.122.0 

func (AppCacheConfigOutput) ElementType() reflect.Type

func (AppCacheConfigOutput) ToAppCacheConfigOutput added in v0.122.0 

func (o AppCacheConfigOutput) ToAppCacheConfigOutput() AppCacheConfigOutput

func (AppCacheConfigOutput) ToAppCacheConfigOutputWithContext added in v0.122.0 

func (o AppCacheConfigOutput) ToAppCacheConfigOutputWithContext(ctx context.Context) AppCacheConfigOutput

func (AppCacheConfigOutput) ToAppCacheConfigPtrOutput added in v0.122.0 

func (o AppCacheConfigOutput) ToAppCacheConfigPtrOutput() AppCacheConfigPtrOutput

func (AppCacheConfigOutput) ToAppCacheConfigPtrOutputWithContext added in v0.122.0 

func (o AppCacheConfigOutput) ToAppCacheConfigPtrOutputWithContext(ctx context.Context) AppCacheConfigPtrOutput

func (AppCacheConfigOutput) Type added in v0.122.0 

func (o AppCacheConfigOutput) Type() AppCacheConfigTypePtrOutput

The type of cache configuration to use for an Amplify app.

The `AMPLIFY_MANAGED` cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.

The `AMPLIFY_MANAGED_NO_COOKIES` cache configuration type is the same as `AMPLIFY_MANAGED` , except that it excludes all cookies from the cache key.

type AppCacheConfigPtrInput added in v0.122.0 

type AppCacheConfigPtrInput interface {
	pulumi.Input

	ToAppCacheConfigPtrOutput() AppCacheConfigPtrOutput
	ToAppCacheConfigPtrOutputWithContext(context.Context) AppCacheConfigPtrOutput
}

AppCacheConfigPtrInput is an input type that accepts AppCacheConfigArgs, AppCacheConfigPtr and AppCacheConfigPtrOutput values. You can construct a concrete instance of `AppCacheConfigPtrInput` via: 

        AppCacheConfigArgs{...}

or:

        nil

func AppCacheConfigPtr added in v0.122.0 

func AppCacheConfigPtr(v *AppCacheConfigArgs) AppCacheConfigPtrInput

type AppCacheConfigPtrOutput added in v0.122.0 

type AppCacheConfigPtrOutput struct{ *pulumi.OutputState }

func (AppCacheConfigPtrOutput) Elem added in v0.122.0 

func (o AppCacheConfigPtrOutput) Elem() AppCacheConfigOutput

func (AppCacheConfigPtrOutput) ElementType added in v0.122.0 

func (AppCacheConfigPtrOutput) ElementType() reflect.Type

func (AppCacheConfigPtrOutput) ToAppCacheConfigPtrOutput added in v0.122.0 

func (o AppCacheConfigPtrOutput) ToAppCacheConfigPtrOutput() AppCacheConfigPtrOutput

func (AppCacheConfigPtrOutput) ToAppCacheConfigPtrOutputWithContext added in v0.122.0 

func (o AppCacheConfigPtrOutput) ToAppCacheConfigPtrOutputWithContext(ctx context.Context) AppCacheConfigPtrOutput

func (AppCacheConfigPtrOutput) Type added in v0.122.0 

func (o AppCacheConfigPtrOutput) Type() AppCacheConfigTypePtrOutput

The type of cache configuration to use for an Amplify app.

The `AMPLIFY_MANAGED` cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.

The `AMPLIFY_MANAGED_NO_COOKIES` cache configuration type is the same as `AMPLIFY_MANAGED` , except that it excludes all cookies from the cache key.

type AppCacheConfigType added in v0.122.0 

type AppCacheConfigType string

The type of cache configuration to use for an Amplify app.

The `AMPLIFY_MANAGED` cache configuration automatically applies an optimized cache configuration for your app based on its platform, routing rules, and rewrite rules. This is the default setting.

The `AMPLIFY_MANAGED_NO_COOKIES` cache configuration type is the same as `AMPLIFY_MANAGED` , except that it excludes all cookies from the cache key.

func (AppCacheConfigType) ElementType added in v0.122.0 

func (AppCacheConfigType) ElementType() reflect.Type

func (AppCacheConfigType) ToAppCacheConfigTypeOutput added in v0.122.0 

func (e AppCacheConfigType) ToAppCacheConfigTypeOutput() AppCacheConfigTypeOutput

func (AppCacheConfigType) ToAppCacheConfigTypeOutputWithContext added in v0.122.0 

func (e AppCacheConfigType) ToAppCacheConfigTypeOutputWithContext(ctx context.Context) AppCacheConfigTypeOutput

func (AppCacheConfigType) ToAppCacheConfigTypePtrOutput added in v0.122.0 

func (e AppCacheConfigType) ToAppCacheConfigTypePtrOutput() AppCacheConfigTypePtrOutput

func (AppCacheConfigType) ToAppCacheConfigTypePtrOutputWithContext added in v0.122.0 

func (e AppCacheConfigType) ToAppCacheConfigTypePtrOutputWithContext(ctx context.Context) AppCacheConfigTypePtrOutput

func (AppCacheConfigType) ToStringOutput added in v0.122.0 

func (e AppCacheConfigType) ToStringOutput() pulumi.StringOutput

func (AppCacheConfigType) ToStringOutputWithContext added in v0.122.0 

func (e AppCacheConfigType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (AppCacheConfigType) ToStringPtrOutput added in v0.122.0 

func (e AppCacheConfigType) ToStringPtrOutput() pulumi.StringPtrOutput

func (AppCacheConfigType) ToStringPtrOutputWithContext added in v0.122.0 

func (e AppCacheConfigType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AppCacheConfigTypeInput added in v0.122.0 

type AppCacheConfigTypeInput interface {
	pulumi.Input

	ToAppCacheConfigTypeOutput() AppCacheConfigTypeOutput
	ToAppCacheConfigTypeOutputWithContext(context.Context) AppCacheConfigTypeOutput
}

AppCacheConfigTypeInput is an input type that accepts values of the AppCacheConfigType enum A concrete instance of `AppCacheConfigTypeInput` can be one of the following: 

AppCacheConfigTypeAmplifyManaged
AppCacheConfigTypeAmplifyManagedNoCookies

type AppCacheConfigTypeOutput added in v0.122.0 

type AppCacheConfigTypeOutput struct{ *pulumi.OutputState }

func (AppCacheConfigTypeOutput) ElementType added in v0.122.0 

func (AppCacheConfigTypeOutput) ElementType() reflect.Type

func (AppCacheConfigTypeOutput) ToAppCacheConfigTypeOutput added in v0.122.0 

func (o AppCacheConfigTypeOutput) ToAppCacheConfigTypeOutput() AppCacheConfigTypeOutput

func (AppCacheConfigTypeOutput) ToAppCacheConfigTypeOutputWithContext added in v0.122.0 

func (o AppCacheConfigTypeOutput) ToAppCacheConfigTypeOutputWithContext(ctx context.Context) AppCacheConfigTypeOutput

func (AppCacheConfigTypeOutput) ToAppCacheConfigTypePtrOutput added in v0.122.0 

func (o AppCacheConfigTypeOutput) ToAppCacheConfigTypePtrOutput() AppCacheConfigTypePtrOutput

func (AppCacheConfigTypeOutput) ToAppCacheConfigTypePtrOutputWithContext added in v0.122.0 

func (o AppCacheConfigTypeOutput) ToAppCacheConfigTypePtrOutputWithContext(ctx context.Context) AppCacheConfigTypePtrOutput

func (AppCacheConfigTypeOutput) ToStringOutput added in v0.122.0 

func (o AppCacheConfigTypeOutput) ToStringOutput() pulumi.StringOutput

func (AppCacheConfigTypeOutput) ToStringOutputWithContext added in v0.122.0 

func (o AppCacheConfigTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (AppCacheConfigTypeOutput) ToStringPtrOutput added in v0.122.0 

func (o AppCacheConfigTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AppCacheConfigTypeOutput) ToStringPtrOutputWithContext added in v0.122.0 

func (o AppCacheConfigTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AppCacheConfigTypePtrInput added in v0.122.0 

type AppCacheConfigTypePtrInput interface {
	pulumi.Input

	ToAppCacheConfigTypePtrOutput() AppCacheConfigTypePtrOutput
	ToAppCacheConfigTypePtrOutputWithContext(context.Context) AppCacheConfigTypePtrOutput
}

func AppCacheConfigTypePtr added in v0.122.0 

func AppCacheConfigTypePtr(v string) AppCacheConfigTypePtrInput

type AppCacheConfigTypePtrOutput added in v0.122.0 

type AppCacheConfigTypePtrOutput struct{ *pulumi.OutputState }

func (AppCacheConfigTypePtrOutput) Elem added in v0.122.0 

func (o AppCacheConfigTypePtrOutput) Elem() AppCacheConfigTypeOutput

func (AppCacheConfigTypePtrOutput) ElementType added in v0.122.0 

func (AppCacheConfigTypePtrOutput) ElementType() reflect.Type

func (AppCacheConfigTypePtrOutput) ToAppCacheConfigTypePtrOutput added in v0.122.0 

func (o AppCacheConfigTypePtrOutput) ToAppCacheConfigTypePtrOutput() AppCacheConfigTypePtrOutput

func (AppCacheConfigTypePtrOutput) ToAppCacheConfigTypePtrOutputWithContext added in v0.122.0 

func (o AppCacheConfigTypePtrOutput) ToAppCacheConfigTypePtrOutputWithContext(ctx context.Context) AppCacheConfigTypePtrOutput

func (AppCacheConfigTypePtrOutput) ToStringPtrOutput added in v0.122.0 

func (o AppCacheConfigTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AppCacheConfigTypePtrOutput) ToStringPtrOutputWithContext added in v0.122.0 

func (o AppCacheConfigTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AppCustomRule 

type AppCustomRule struct {
	// The condition for a URL rewrite or redirect rule, such as a country code.
	Condition *string `pulumi:"condition"`
	// The source pattern for a URL rewrite or redirect rule.
	Source string `pulumi:"source"`
	// The status code for a URL rewrite or redirect rule.
	//
	// - **200** - Represents a 200 rewrite rule.
	// - **301** - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
	// - **302** - Represents a 302 temporary redirect rule.
	// - **404** - Represents a 404 redirect rule.
	// - **404-200** - Represents a 404 rewrite rule.
	Status *string `pulumi:"status"`
	// The target pattern for a URL rewrite or redirect rule.
	Target string `pulumi:"target"`
}

type AppCustomRuleArgs 

type AppCustomRuleArgs struct {
	// The condition for a URL rewrite or redirect rule, such as a country code.
	Condition pulumi.StringPtrInput `pulumi:"condition"`
	// The source pattern for a URL rewrite or redirect rule.
	Source pulumi.StringInput `pulumi:"source"`
	// The status code for a URL rewrite or redirect rule.
	//
	// - **200** - Represents a 200 rewrite rule.
	// - **301** - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL.
	// - **302** - Represents a 302 temporary redirect rule.
	// - **404** - Represents a 404 redirect rule.
	// - **404-200** - Represents a 404 rewrite rule.
	Status pulumi.StringPtrInput `pulumi:"status"`
	// The target pattern for a URL rewrite or redirect rule.
	Target pulumi.StringInput `pulumi:"target"`
}

func (AppCustomRuleArgs) ElementType 

func (AppCustomRuleArgs) ElementType() reflect.Type

func (AppCustomRuleArgs) ToAppCustomRuleOutput 

func (i AppCustomRuleArgs) ToAppCustomRuleOutput() AppCustomRuleOutput

func (AppCustomRuleArgs) ToAppCustomRuleOutputWithContext 

func (i AppCustomRuleArgs) ToAppCustomRuleOutputWithContext(ctx context.Context) AppCustomRuleOutput

type AppCustomRuleArray 

type AppCustomRuleArray []AppCustomRuleInput

func (AppCustomRuleArray) ElementType 

func (AppCustomRuleArray) ElementType() reflect.Type

func (AppCustomRuleArray) ToAppCustomRuleArrayOutput 

func (i AppCustomRuleArray) ToAppCustomRuleArrayOutput() AppCustomRuleArrayOutput

func (AppCustomRuleArray) ToAppCustomRuleArrayOutputWithContext 

func (i AppCustomRuleArray) ToAppCustomRuleArrayOutputWithContext(ctx context.Context) AppCustomRuleArrayOutput

type AppCustomRuleArrayInput 

type AppCustomRuleArrayInput interface {
	pulumi.Input

	ToAppCustomRuleArrayOutput() AppCustomRuleArrayOutput
	ToAppCustomRuleArrayOutputWithContext(context.Context) AppCustomRuleArrayOutput
}

AppCustomRuleArrayInput is an input type that accepts AppCustomRuleArray and AppCustomRuleArrayOutput values. You can construct a concrete instance of `AppCustomRuleArrayInput` via: 

AppCustomRuleArray{ AppCustomRuleArgs{...} }

type AppCustomRuleArrayOutput 

type AppCustomRuleArrayOutput struct{ *pulumi.OutputState }

func (AppCustomRuleArrayOutput) ElementType 

func (AppCustomRuleArrayOutput) ElementType() reflect.Type

func (AppCustomRuleArrayOutput) Index 

func (o AppCustomRuleArrayOutput) Index(i pulumi.IntInput) AppCustomRuleOutput

func (AppCustomRuleArrayOutput) ToAppCustomRuleArrayOutput 

func (o AppCustomRuleArrayOutput) ToAppCustomRuleArrayOutput() AppCustomRuleArrayOutput

func (AppCustomRuleArrayOutput) ToAppCustomRuleArrayOutputWithContext 

func (o AppCustomRuleArrayOutput) ToAppCustomRuleArrayOutputWithContext(ctx context.Context) AppCustomRuleArrayOutput

type AppCustomRuleInput 

type AppCustomRuleInput interface {
	pulumi.Input

	ToAppCustomRuleOutput() AppCustomRuleOutput
	ToAppCustomRuleOutputWithContext(context.Context) AppCustomRuleOutput
}

AppCustomRuleInput is an input type that accepts AppCustomRuleArgs and AppCustomRuleOutput values. You can construct a concrete instance of `AppCustomRuleInput` via: 

AppCustomRuleArgs{...}

type AppCustomRuleOutput 

type AppCustomRuleOutput struct{ *pulumi.OutputState }

func (AppCustomRuleOutput) Condition 

func (o AppCustomRuleOutput) Condition() pulumi.StringPtrOutput

The condition for a URL rewrite or redirect rule, such as a country code.

func (AppCustomRuleOutput) ElementType 

func (AppCustomRuleOutput) ElementType() reflect.Type

func (AppCustomRuleOutput) Source 

func (o AppCustomRuleOutput) Source() pulumi.StringOutput

The source pattern for a URL rewrite or redirect rule.

func (AppCustomRuleOutput) Status 

func (o AppCustomRuleOutput) Status() pulumi.StringPtrOutput

The status code for a URL rewrite or redirect rule.

- **200** - Represents a 200 rewrite rule. - **301** - Represents a 301 (moved pemanently) redirect rule. This and all future requests should be directed to the target URL. - **302** - Represents a 302 temporary redirect rule. - **404** - Represents a 404 redirect rule. - **404-200** - Represents a 404 rewrite rule.

func (AppCustomRuleOutput) Target 

func (o AppCustomRuleOutput) Target() pulumi.StringOutput

The target pattern for a URL rewrite or redirect rule.

func (AppCustomRuleOutput) ToAppCustomRuleOutput 

func (o AppCustomRuleOutput) ToAppCustomRuleOutput() AppCustomRuleOutput

func (AppCustomRuleOutput) ToAppCustomRuleOutputWithContext 

func (o AppCustomRuleOutput) ToAppCustomRuleOutputWithContext(ctx context.Context) AppCustomRuleOutput

type AppEnvironmentVariable 

type AppEnvironmentVariable struct {
	// The environment variable name.
	Name string `pulumi:"name"`
	// The environment variable value.
	Value string `pulumi:"value"`
}

type AppEnvironmentVariableArgs 

type AppEnvironmentVariableArgs struct {
	// The environment variable name.
	Name pulumi.StringInput `pulumi:"name"`
	// The environment variable value.
	Value pulumi.StringInput `pulumi:"value"`
}

func (AppEnvironmentVariableArgs) ElementType 

func (AppEnvironmentVariableArgs) ElementType() reflect.Type

func (AppEnvironmentVariableArgs) ToAppEnvironmentVariableOutput 

func (i AppEnvironmentVariableArgs) ToAppEnvironmentVariableOutput() AppEnvironmentVariableOutput

func (AppEnvironmentVariableArgs) ToAppEnvironmentVariableOutputWithContext 

func (i AppEnvironmentVariableArgs) ToAppEnvironmentVariableOutputWithContext(ctx context.Context) AppEnvironmentVariableOutput

type AppEnvironmentVariableArray 

type AppEnvironmentVariableArray []AppEnvironmentVariableInput

func (AppEnvironmentVariableArray) ElementType 

func (AppEnvironmentVariableArray) ElementType() reflect.Type

func (AppEnvironmentVariableArray) ToAppEnvironmentVariableArrayOutput 

func (i AppEnvironmentVariableArray) ToAppEnvironmentVariableArrayOutput() AppEnvironmentVariableArrayOutput

func (AppEnvironmentVariableArray) ToAppEnvironmentVariableArrayOutputWithContext 

func (i AppEnvironmentVariableArray) ToAppEnvironmentVariableArrayOutputWithContext(ctx context.Context) AppEnvironmentVariableArrayOutput

type AppEnvironmentVariableArrayInput 

type AppEnvironmentVariableArrayInput interface {
	pulumi.Input

	ToAppEnvironmentVariableArrayOutput() AppEnvironmentVariableArrayOutput
	ToAppEnvironmentVariableArrayOutputWithContext(context.Context) AppEnvironmentVariableArrayOutput
}

AppEnvironmentVariableArrayInput is an input type that accepts AppEnvironmentVariableArray and AppEnvironmentVariableArrayOutput values. You can construct a concrete instance of `AppEnvironmentVariableArrayInput` via: 

AppEnvironmentVariableArray{ AppEnvironmentVariableArgs{...} }

type AppEnvironmentVariableArrayOutput 

type AppEnvironmentVariableArrayOutput struct{ *pulumi.OutputState }

func (AppEnvironmentVariableArrayOutput) ElementType 

func (AppEnvironmentVariableArrayOutput) ElementType() reflect.Type

func (AppEnvironmentVariableArrayOutput) Index 

func (o AppEnvironmentVariableArrayOutput) Index(i pulumi.IntInput) AppEnvironmentVariableOutput

func (AppEnvironmentVariableArrayOutput) ToAppEnvironmentVariableArrayOutput 

func (o AppEnvironmentVariableArrayOutput) ToAppEnvironmentVariableArrayOutput() AppEnvironmentVariableArrayOutput

func (AppEnvironmentVariableArrayOutput) ToAppEnvironmentVariableArrayOutputWithContext 

func (o AppEnvironmentVariableArrayOutput) ToAppEnvironmentVariableArrayOutputWithContext(ctx context.Context) AppEnvironmentVariableArrayOutput

type AppEnvironmentVariableInput 

type AppEnvironmentVariableInput interface {
	pulumi.Input

	ToAppEnvironmentVariableOutput() AppEnvironmentVariableOutput
	ToAppEnvironmentVariableOutputWithContext(context.Context) AppEnvironmentVariableOutput
}

AppEnvironmentVariableInput is an input type that accepts AppEnvironmentVariableArgs and AppEnvironmentVariableOutput values. You can construct a concrete instance of `AppEnvironmentVariableInput` via: 

AppEnvironmentVariableArgs{...}

type AppEnvironmentVariableOutput 

type AppEnvironmentVariableOutput struct{ *pulumi.OutputState }

func (AppEnvironmentVariableOutput) ElementType 

func (AppEnvironmentVariableOutput) ElementType() reflect.Type

func (AppEnvironmentVariableOutput) Name 

func (o AppEnvironmentVariableOutput) Name() pulumi.StringOutput

The environment variable name.

func (AppEnvironmentVariableOutput) ToAppEnvironmentVariableOutput 

func (o AppEnvironmentVariableOutput) ToAppEnvironmentVariableOutput() AppEnvironmentVariableOutput

func (AppEnvironmentVariableOutput) ToAppEnvironmentVariableOutputWithContext 

func (o AppEnvironmentVariableOutput) ToAppEnvironmentVariableOutputWithContext(ctx context.Context) AppEnvironmentVariableOutput

func (AppEnvironmentVariableOutput) Value 

func (o AppEnvironmentVariableOutput) Value() pulumi.StringOutput

The environment variable value.

type AppInput 

type AppInput interface {
	pulumi.Input

	ToAppOutput() AppOutput
	ToAppOutputWithContext(ctx context.Context) AppOutput
}

type AppOutput 

type AppOutput struct{ *pulumi.OutputState }

func (AppOutput) AccessToken added in v0.17.0 

func (o AppOutput) AccessToken() pulumi.StringPtrOutput

The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored.

Use `AccessToken` for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use `OauthToken` .

You must specify either `AccessToken` or `OauthToken` when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* .

func (AppOutput) AppId added in v0.17.0 

func (o AppOutput) AppId() pulumi.StringOutput

Unique Id for the Amplify App.

func (AppOutput) AppName added in v0.17.0 

func (o AppOutput) AppName() pulumi.StringOutput

Name for the Amplify App.

func (AppOutput) Arn added in v0.17.0 

func (o AppOutput) Arn() pulumi.StringOutput

ARN for the Amplify App.

func (AppOutput) AutoBranchCreationConfig added in v0.17.0 

func (o AppOutput) AutoBranchCreationConfig() AppAutoBranchCreationConfigPtrOutput

Sets the configuration for your automatic branch creation.

func (AppOutput) BasicAuthConfig added in v0.17.0 

func (o AppOutput) BasicAuthConfig() AppBasicAuthConfigPtrOutput

The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format `user:password` .

func (AppOutput) BuildSpec added in v0.17.0 

func (o AppOutput) BuildSpec() pulumi.StringPtrOutput

The build specification (build spec) for an Amplify app.

func (AppOutput) CacheConfig added in v0.122.0 

func (o AppOutput) CacheConfig() AppCacheConfigPtrOutput

The cache configuration for the Amplify app. If you don't specify the cache configuration `type` , Amplify uses the default `AMPLIFY_MANAGED` setting.

func (AppOutput) CustomHeaders added in v0.17.0 

func (o AppOutput) CustomHeaders() pulumi.StringPtrOutput

The custom HTTP headers for an Amplify app.

func (AppOutput) CustomRules added in v0.17.0 

func (o AppOutput) CustomRules() AppCustomRuleArrayOutput

The custom rewrite and redirect rules for an Amplify app.

func (AppOutput) DefaultDomain added in v0.17.0 

func (o AppOutput) DefaultDomain() pulumi.StringOutput

Default domain for the Amplify App.

func (AppOutput) Description added in v0.17.0 

func (o AppOutput) Description() pulumi.StringPtrOutput

The description of the Amplify app.

func (AppOutput) ElementType 

func (AppOutput) ElementType() reflect.Type

func (AppOutput) EnableBranchAutoDeletion added in v0.17.0 

func (o AppOutput) EnableBranchAutoDeletion() pulumi.BoolPtrOutput

Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

func (AppOutput) EnvironmentVariables added in v0.17.0 

func (o AppOutput) EnvironmentVariables() AppEnvironmentVariableArrayOutput

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see [Amplify Environment variables](https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html) in the *Amplify Hosting User Guide* .

func (AppOutput) IamServiceRole added in v0.72.0 

func (o AppOutput) IamServiceRole() pulumi.StringPtrOutput

AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.

func (AppOutput) Name added in v0.17.0 

func (o AppOutput) Name() pulumi.StringOutput

The name of the Amplify app.

func (AppOutput) OauthToken added in v0.17.0 

func (o AppOutput) OauthToken() pulumi.StringPtrOutput

The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored.

Use `OauthToken` for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use `AccessToken` .

You must specify either `OauthToken` or `AccessToken` when you create a new app.

Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see [Migrating an existing OAuth app to the Amplify GitHub App](https://docs.aws.amazon.com/amplify/latest/userguide/setting-up-GitHub-access.html#migrating-to-github-app-auth) in the *Amplify User Guide* .

func (AppOutput) Platform added in v0.41.0 

func (o AppOutput) Platform() AppPlatformPtrOutput

The platform for the Amplify app. For a static app, set the platform type to `WEB` . For a dynamic server-side rendered (SSR) app, set the platform type to `WEB_COMPUTE` . For an app requiring Amplify Hosting's original SSR support only, set the platform type to `WEB_DYNAMIC` .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to `WEB_COMPUTE` and set the artifacts `baseDirectory` to `.next` in the application's build settings. For an example of the build specification settings, see [Amplify build settings for a Next.js 14 SSG application](https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14) in the *Amplify Hosting User Guide* .

func (AppOutput) Repository added in v0.17.0 

func (o AppOutput) Repository() pulumi.StringPtrOutput

The Git repository for the Amplify app.

func (AppOutput) Tags added in v0.17.0 

func (o AppOutput) Tags() aws.TagArrayOutput

The tag for an Amplify app.

func (AppOutput) ToAppOutput 

func (o AppOutput) ToAppOutput() AppOutput

func (AppOutput) ToAppOutputWithContext 

func (o AppOutput) ToAppOutputWithContext(ctx context.Context) AppOutput

type AppPlatform added in v0.41.0 

type AppPlatform string

The platform for the Amplify app. For a static app, set the platform type to `WEB` . For a dynamic server-side rendered (SSR) app, set the platform type to `WEB_COMPUTE` . For an app requiring Amplify Hosting's original SSR support only, set the platform type to `WEB_DYNAMIC` .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to `WEB_COMPUTE` and set the artifacts `baseDirectory` to `.next` in the application's build settings. For an example of the build specification settings, see [Amplify build settings for a Next.js 14 SSG application](https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14) in the *Amplify Hosting User Guide* .

func (AppPlatform) ElementType added in v0.41.0 

func (AppPlatform) ElementType() reflect.Type

func (AppPlatform) ToAppPlatformOutput added in v0.41.0 

func (e AppPlatform) ToAppPlatformOutput() AppPlatformOutput

func (AppPlatform) ToAppPlatformOutputWithContext added in v0.41.0 

func (e AppPlatform) ToAppPlatformOutputWithContext(ctx context.Context) AppPlatformOutput

func (AppPlatform) ToAppPlatformPtrOutput added in v0.41.0 

func (e AppPlatform) ToAppPlatformPtrOutput() AppPlatformPtrOutput

func (AppPlatform) ToAppPlatformPtrOutputWithContext added in v0.41.0 

func (e AppPlatform) ToAppPlatformPtrOutputWithContext(ctx context.Context) AppPlatformPtrOutput

func (AppPlatform) ToStringOutput added in v0.41.0 

func (e AppPlatform) ToStringOutput() pulumi.StringOutput

func (AppPlatform) ToStringOutputWithContext added in v0.41.0 

func (e AppPlatform) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (AppPlatform) ToStringPtrOutput added in v0.41.0 

func (e AppPlatform) ToStringPtrOutput() pulumi.StringPtrOutput

func (AppPlatform) ToStringPtrOutputWithContext added in v0.41.0 

func (e AppPlatform) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AppPlatformInput added in v0.41.0 

type AppPlatformInput interface {
	pulumi.Input

	ToAppPlatformOutput() AppPlatformOutput
	ToAppPlatformOutputWithContext(context.Context) AppPlatformOutput
}

AppPlatformInput is an input type that accepts values of the AppPlatform enum A concrete instance of `AppPlatformInput` can be one of the following: 

AppPlatformWeb
AppPlatformWebDynamic
AppPlatformWebCompute

type AppPlatformOutput added in v0.41.0 

type AppPlatformOutput struct{ *pulumi.OutputState }

func (AppPlatformOutput) ElementType added in v0.41.0 

func (AppPlatformOutput) ElementType() reflect.Type

func (AppPlatformOutput) ToAppPlatformOutput added in v0.41.0 

func (o AppPlatformOutput) ToAppPlatformOutput() AppPlatformOutput

func (AppPlatformOutput) ToAppPlatformOutputWithContext added in v0.41.0 

func (o AppPlatformOutput) ToAppPlatformOutputWithContext(ctx context.Context) AppPlatformOutput

func (AppPlatformOutput) ToAppPlatformPtrOutput added in v0.41.0 

func (o AppPlatformOutput) ToAppPlatformPtrOutput() AppPlatformPtrOutput

func (AppPlatformOutput) ToAppPlatformPtrOutputWithContext added in v0.41.0 

func (o AppPlatformOutput) ToAppPlatformPtrOutputWithContext(ctx context.Context) AppPlatformPtrOutput

func (AppPlatformOutput) ToStringOutput added in v0.41.0 

func (o AppPlatformOutput) ToStringOutput() pulumi.StringOutput

func (AppPlatformOutput) ToStringOutputWithContext added in v0.41.0 

func (o AppPlatformOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (AppPlatformOutput) ToStringPtrOutput added in v0.41.0 

func (o AppPlatformOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AppPlatformOutput) ToStringPtrOutputWithContext added in v0.41.0 

func (o AppPlatformOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AppPlatformPtrInput added in v0.41.0 

type AppPlatformPtrInput interface {
	pulumi.Input

	ToAppPlatformPtrOutput() AppPlatformPtrOutput
	ToAppPlatformPtrOutputWithContext(context.Context) AppPlatformPtrOutput
}

func AppPlatformPtr added in v0.41.0 

func AppPlatformPtr(v string) AppPlatformPtrInput

type AppPlatformPtrOutput added in v0.41.0 

type AppPlatformPtrOutput struct{ *pulumi.OutputState }

func (AppPlatformPtrOutput) Elem added in v0.41.0 

func (o AppPlatformPtrOutput) Elem() AppPlatformOutput

func (AppPlatformPtrOutput) ElementType added in v0.41.0 

func (AppPlatformPtrOutput) ElementType() reflect.Type

func (AppPlatformPtrOutput) ToAppPlatformPtrOutput added in v0.41.0 

func (o AppPlatformPtrOutput) ToAppPlatformPtrOutput() AppPlatformPtrOutput

func (AppPlatformPtrOutput) ToAppPlatformPtrOutputWithContext added in v0.41.0 

func (o AppPlatformPtrOutput) ToAppPlatformPtrOutputWithContext(ctx context.Context) AppPlatformPtrOutput

func (AppPlatformPtrOutput) ToStringPtrOutput added in v0.41.0 

func (o AppPlatformPtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (AppPlatformPtrOutput) ToStringPtrOutputWithContext added in v0.41.0 

func (o AppPlatformPtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type AppState 

type AppState struct {
}

func (AppState) ElementType 

func (AppState) ElementType() reflect.Type

type AppTag 

type AppTag struct {
	// Specifies the key for the tag.
	Key string `pulumi:"key"`
	// Specifies the value for the tag.
	Value string `pulumi:"value"`
}

type Branch 

type Branch struct {
	pulumi.CustomResourceState

	// The unique ID for an Amplify app.
	AppId pulumi.StringOutput `pulumi:"appId"`
	// ARN for a branch, part of an Amplify App.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The backend for a `Branch` of an Amplify app. Use for a backend created from an AWS CloudFormation stack.
	//
	// This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
	Backend BranchBackendPtrOutput `pulumi:"backend"`
	// The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format `user:password` .
	BasicAuthConfig BranchBasicAuthConfigPtrOutput `pulumi:"basicAuthConfig"`
	// The name for the branch.
	BranchName pulumi.StringOutput `pulumi:"branchName"`
	// The build specification (build spec) for the branch.
	BuildSpec pulumi.StringPtrOutput `pulumi:"buildSpec"`
	// The description for the branch that is part of an Amplify app.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Enables auto building for the branch.
	EnableAutoBuild pulumi.BoolPtrOutput `pulumi:"enableAutoBuild"`
	// Enables performance mode for the branch.
	//
	// Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
	EnablePerformanceMode pulumi.BoolPtrOutput `pulumi:"enablePerformanceMode"`
	// Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.
	//
	// To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.
	//
	// For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .
	EnablePullRequestPreview pulumi.BoolPtrOutput `pulumi:"enablePullRequestPreview"`
	// The environment variables for the branch.
	EnvironmentVariables BranchEnvironmentVariableArrayOutput `pulumi:"environmentVariables"`
	// The framework for the branch.
	Framework pulumi.StringPtrOutput `pulumi:"framework"`
	// If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI and mapped to this branch.
	//
	// To enable pull request previews, set the `EnablePullRequestPreview` property to `true` .
	//
	// If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed.
	//
	// For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .
	PullRequestEnvironmentName pulumi.StringPtrOutput `pulumi:"pullRequestEnvironmentName"`
	// Describes the current stage for the branch.
	Stage BranchStagePtrOutput `pulumi:"stage"`
	// The tag for the branch.
	Tags aws.TagArrayOutput `pulumi:"tags"`
}

The AWS::Amplify::Branch resource creates a new branch within an app.

func GetBranch 

func GetBranch(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BranchState, opts ...pulumi.ResourceOption) (*Branch, error)

GetBranch gets an existing Branch resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewBranch 

func NewBranch(ctx *pulumi.Context,
	name string, args *BranchArgs, opts ...pulumi.ResourceOption) (*Branch, error)

NewBranch registers a new resource with the given unique name, arguments, and options.

func (*Branch) ElementType 

func (*Branch) ElementType() reflect.Type

func (*Branch) ToBranchOutput 

func (i *Branch) ToBranchOutput() BranchOutput

func (*Branch) ToBranchOutputWithContext 

func (i *Branch) ToBranchOutputWithContext(ctx context.Context) BranchOutput

type BranchArgs 

type BranchArgs struct {
	// The unique ID for an Amplify app.
	AppId pulumi.StringInput
	// The backend for a `Branch` of an Amplify app. Use for a backend created from an AWS CloudFormation stack.
	//
	// This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
	Backend BranchBackendPtrInput
	// The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format `user:password` .
	BasicAuthConfig BranchBasicAuthConfigPtrInput
	// The name for the branch.
	BranchName pulumi.StringPtrInput
	// The build specification (build spec) for the branch.
	BuildSpec pulumi.StringPtrInput
	// The description for the branch that is part of an Amplify app.
	Description pulumi.StringPtrInput
	// Enables auto building for the branch.
	EnableAutoBuild pulumi.BoolPtrInput
	// Enables performance mode for the branch.
	//
	// Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
	EnablePerformanceMode pulumi.BoolPtrInput
	// Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.
	//
	// To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.
	//
	// For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .
	EnablePullRequestPreview pulumi.BoolPtrInput
	// The environment variables for the branch.
	EnvironmentVariables BranchEnvironmentVariableArrayInput
	// The framework for the branch.
	Framework pulumi.StringPtrInput
	// If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI and mapped to this branch.
	//
	// To enable pull request previews, set the `EnablePullRequestPreview` property to `true` .
	//
	// If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed.
	//
	// For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .
	PullRequestEnvironmentName pulumi.StringPtrInput
	// Describes the current stage for the branch.
	Stage BranchStagePtrInput
	// The tag for the branch.
	Tags aws.TagArrayInput
}

The set of arguments for constructing a Branch resource.

func (BranchArgs) ElementType 

func (BranchArgs) ElementType() reflect.Type

type BranchBackend added in v0.83.0 

type BranchBackend struct {
	// The Amazon Resource Name (ARN) for the AWS CloudFormation stack.
	StackArn *string `pulumi:"stackArn"`
}

type BranchBackendArgs added in v0.83.0 

type BranchBackendArgs struct {
	// The Amazon Resource Name (ARN) for the AWS CloudFormation stack.
	StackArn pulumi.StringPtrInput `pulumi:"stackArn"`
}

func (BranchBackendArgs) ElementType added in v0.83.0 

func (BranchBackendArgs) ElementType() reflect.Type

func (BranchBackendArgs) ToBranchBackendOutput added in v0.83.0 

func (i BranchBackendArgs) ToBranchBackendOutput() BranchBackendOutput

func (BranchBackendArgs) ToBranchBackendOutputWithContext added in v0.83.0 

func (i BranchBackendArgs) ToBranchBackendOutputWithContext(ctx context.Context) BranchBackendOutput

func (BranchBackendArgs) ToBranchBackendPtrOutput added in v0.83.0 

func (i BranchBackendArgs) ToBranchBackendPtrOutput() BranchBackendPtrOutput

func (BranchBackendArgs) ToBranchBackendPtrOutputWithContext added in v0.83.0 

func (i BranchBackendArgs) ToBranchBackendPtrOutputWithContext(ctx context.Context) BranchBackendPtrOutput

type BranchBackendInput added in v0.83.0 

type BranchBackendInput interface {
	pulumi.Input

	ToBranchBackendOutput() BranchBackendOutput
	ToBranchBackendOutputWithContext(context.Context) BranchBackendOutput
}

BranchBackendInput is an input type that accepts BranchBackendArgs and BranchBackendOutput values. You can construct a concrete instance of `BranchBackendInput` via: 

BranchBackendArgs{...}

type BranchBackendOutput added in v0.83.0 

type BranchBackendOutput struct{ *pulumi.OutputState }

func (BranchBackendOutput) ElementType added in v0.83.0 

func (BranchBackendOutput) ElementType() reflect.Type

func (BranchBackendOutput) StackArn added in v0.83.0 

func (o BranchBackendOutput) StackArn() pulumi.StringPtrOutput

The Amazon Resource Name (ARN) for the AWS CloudFormation stack.

func (BranchBackendOutput) ToBranchBackendOutput added in v0.83.0 

func (o BranchBackendOutput) ToBranchBackendOutput() BranchBackendOutput

func (BranchBackendOutput) ToBranchBackendOutputWithContext added in v0.83.0 

func (o BranchBackendOutput) ToBranchBackendOutputWithContext(ctx context.Context) BranchBackendOutput

func (BranchBackendOutput) ToBranchBackendPtrOutput added in v0.83.0 

func (o BranchBackendOutput) ToBranchBackendPtrOutput() BranchBackendPtrOutput

func (BranchBackendOutput) ToBranchBackendPtrOutputWithContext added in v0.83.0 

func (o BranchBackendOutput) ToBranchBackendPtrOutputWithContext(ctx context.Context) BranchBackendPtrOutput

type BranchBackendPtrInput added in v0.83.0 

type BranchBackendPtrInput interface {
	pulumi.Input

	ToBranchBackendPtrOutput() BranchBackendPtrOutput
	ToBranchBackendPtrOutputWithContext(context.Context) BranchBackendPtrOutput
}

BranchBackendPtrInput is an input type that accepts BranchBackendArgs, BranchBackendPtr and BranchBackendPtrOutput values. You can construct a concrete instance of `BranchBackendPtrInput` via: 

        BranchBackendArgs{...}

or:

        nil

func BranchBackendPtr added in v0.83.0 

func BranchBackendPtr(v *BranchBackendArgs) BranchBackendPtrInput

type BranchBackendPtrOutput added in v0.83.0 

type BranchBackendPtrOutput struct{ *pulumi.OutputState }

func (BranchBackendPtrOutput) Elem added in v0.83.0 

func (o BranchBackendPtrOutput) Elem() BranchBackendOutput

func (BranchBackendPtrOutput) ElementType added in v0.83.0 

func (BranchBackendPtrOutput) ElementType() reflect.Type

func (BranchBackendPtrOutput) StackArn added in v0.83.0 

func (o BranchBackendPtrOutput) StackArn() pulumi.StringPtrOutput

The Amazon Resource Name (ARN) for the AWS CloudFormation stack.

func (BranchBackendPtrOutput) ToBranchBackendPtrOutput added in v0.83.0 

func (o BranchBackendPtrOutput) ToBranchBackendPtrOutput() BranchBackendPtrOutput

func (BranchBackendPtrOutput) ToBranchBackendPtrOutputWithContext added in v0.83.0 

func (o BranchBackendPtrOutput) ToBranchBackendPtrOutputWithContext(ctx context.Context) BranchBackendPtrOutput

type BranchBasicAuthConfig 

type BranchBasicAuthConfig struct {
	// Enables basic authorization for the branch.
	EnableBasicAuth *bool `pulumi:"enableBasicAuth"`
	// The password for basic authorization.
	Password string `pulumi:"password"`
	Username string `pulumi:"username"`
}

type BranchBasicAuthConfigArgs 

type BranchBasicAuthConfigArgs struct {
	// Enables basic authorization for the branch.
	EnableBasicAuth pulumi.BoolPtrInput `pulumi:"enableBasicAuth"`
	// The password for basic authorization.
	Password pulumi.StringInput `pulumi:"password"`
	Username pulumi.StringInput `pulumi:"username"`
}

func (BranchBasicAuthConfigArgs) ElementType 

func (BranchBasicAuthConfigArgs) ElementType() reflect.Type

func (BranchBasicAuthConfigArgs) ToBranchBasicAuthConfigOutput 

func (i BranchBasicAuthConfigArgs) ToBranchBasicAuthConfigOutput() BranchBasicAuthConfigOutput

func (BranchBasicAuthConfigArgs) ToBranchBasicAuthConfigOutputWithContext 

func (i BranchBasicAuthConfigArgs) ToBranchBasicAuthConfigOutputWithContext(ctx context.Context) BranchBasicAuthConfigOutput

func (BranchBasicAuthConfigArgs) ToBranchBasicAuthConfigPtrOutput 

func (i BranchBasicAuthConfigArgs) ToBranchBasicAuthConfigPtrOutput() BranchBasicAuthConfigPtrOutput

func (BranchBasicAuthConfigArgs) ToBranchBasicAuthConfigPtrOutputWithContext 

func (i BranchBasicAuthConfigArgs) ToBranchBasicAuthConfigPtrOutputWithContext(ctx context.Context) BranchBasicAuthConfigPtrOutput

type BranchBasicAuthConfigInput 

type BranchBasicAuthConfigInput interface {
	pulumi.Input

	ToBranchBasicAuthConfigOutput() BranchBasicAuthConfigOutput
	ToBranchBasicAuthConfigOutputWithContext(context.Context) BranchBasicAuthConfigOutput
}

BranchBasicAuthConfigInput is an input type that accepts BranchBasicAuthConfigArgs and BranchBasicAuthConfigOutput values. You can construct a concrete instance of `BranchBasicAuthConfigInput` via: 

BranchBasicAuthConfigArgs{...}

type BranchBasicAuthConfigOutput 

type BranchBasicAuthConfigOutput struct{ *pulumi.OutputState }

func (BranchBasicAuthConfigOutput) ElementType 

func (BranchBasicAuthConfigOutput) ElementType() reflect.Type

func (BranchBasicAuthConfigOutput) EnableBasicAuth 

func (o BranchBasicAuthConfigOutput) EnableBasicAuth() pulumi.BoolPtrOutput

Enables basic authorization for the branch.

func (BranchBasicAuthConfigOutput) Password 

func (o BranchBasicAuthConfigOutput) Password() pulumi.StringOutput

The password for basic authorization.

func (BranchBasicAuthConfigOutput) ToBranchBasicAuthConfigOutput 

func (o BranchBasicAuthConfigOutput) ToBranchBasicAuthConfigOutput() BranchBasicAuthConfigOutput

func (BranchBasicAuthConfigOutput) ToBranchBasicAuthConfigOutputWithContext 

func (o BranchBasicAuthConfigOutput) ToBranchBasicAuthConfigOutputWithContext(ctx context.Context) BranchBasicAuthConfigOutput

func (BranchBasicAuthConfigOutput) ToBranchBasicAuthConfigPtrOutput 

func (o BranchBasicAuthConfigOutput) ToBranchBasicAuthConfigPtrOutput() BranchBasicAuthConfigPtrOutput

func (BranchBasicAuthConfigOutput) ToBranchBasicAuthConfigPtrOutputWithContext 

func (o BranchBasicAuthConfigOutput) ToBranchBasicAuthConfigPtrOutputWithContext(ctx context.Context) BranchBasicAuthConfigPtrOutput

func (BranchBasicAuthConfigOutput) Username 

func (o BranchBasicAuthConfigOutput) Username() pulumi.StringOutput

type BranchBasicAuthConfigPtrInput 

type BranchBasicAuthConfigPtrInput interface {
	pulumi.Input

	ToBranchBasicAuthConfigPtrOutput() BranchBasicAuthConfigPtrOutput
	ToBranchBasicAuthConfigPtrOutputWithContext(context.Context) BranchBasicAuthConfigPtrOutput
}

BranchBasicAuthConfigPtrInput is an input type that accepts BranchBasicAuthConfigArgs, BranchBasicAuthConfigPtr and BranchBasicAuthConfigPtrOutput values. You can construct a concrete instance of `BranchBasicAuthConfigPtrInput` via: 

        BranchBasicAuthConfigArgs{...}

or:

        nil

func BranchBasicAuthConfigPtr 

func BranchBasicAuthConfigPtr(v *BranchBasicAuthConfigArgs) BranchBasicAuthConfigPtrInput

type BranchBasicAuthConfigPtrOutput 

type BranchBasicAuthConfigPtrOutput struct{ *pulumi.OutputState }

func (BranchBasicAuthConfigPtrOutput) Elem 

func (o BranchBasicAuthConfigPtrOutput) Elem() BranchBasicAuthConfigOutput

func (BranchBasicAuthConfigPtrOutput) ElementType 

func (BranchBasicAuthConfigPtrOutput) ElementType() reflect.Type

func (BranchBasicAuthConfigPtrOutput) EnableBasicAuth 

func (o BranchBasicAuthConfigPtrOutput) EnableBasicAuth() pulumi.BoolPtrOutput

Enables basic authorization for the branch.

func (BranchBasicAuthConfigPtrOutput) Password 

func (o BranchBasicAuthConfigPtrOutput) Password() pulumi.StringPtrOutput

The password for basic authorization.

func (BranchBasicAuthConfigPtrOutput) ToBranchBasicAuthConfigPtrOutput 

func (o BranchBasicAuthConfigPtrOutput) ToBranchBasicAuthConfigPtrOutput() BranchBasicAuthConfigPtrOutput

func (BranchBasicAuthConfigPtrOutput) ToBranchBasicAuthConfigPtrOutputWithContext 

func (o BranchBasicAuthConfigPtrOutput) ToBranchBasicAuthConfigPtrOutputWithContext(ctx context.Context) BranchBasicAuthConfigPtrOutput

func (BranchBasicAuthConfigPtrOutput) Username 

func (o BranchBasicAuthConfigPtrOutput) Username() pulumi.StringPtrOutput

type BranchEnvironmentVariable 

type BranchEnvironmentVariable struct {
	// The environment variable name.
	Name string `pulumi:"name"`
	// The environment variable value.
	Value string `pulumi:"value"`
}

type BranchEnvironmentVariableArgs 

type BranchEnvironmentVariableArgs struct {
	// The environment variable name.
	Name pulumi.StringInput `pulumi:"name"`
	// The environment variable value.
	Value pulumi.StringInput `pulumi:"value"`
}

func (BranchEnvironmentVariableArgs) ElementType 

func (BranchEnvironmentVariableArgs) ElementType() reflect.Type

func (BranchEnvironmentVariableArgs) ToBranchEnvironmentVariableOutput 

func (i BranchEnvironmentVariableArgs) ToBranchEnvironmentVariableOutput() BranchEnvironmentVariableOutput

func (BranchEnvironmentVariableArgs) ToBranchEnvironmentVariableOutputWithContext 

func (i BranchEnvironmentVariableArgs) ToBranchEnvironmentVariableOutputWithContext(ctx context.Context) BranchEnvironmentVariableOutput

type BranchEnvironmentVariableArray 

type BranchEnvironmentVariableArray []BranchEnvironmentVariableInput

func (BranchEnvironmentVariableArray) ElementType 

func (BranchEnvironmentVariableArray) ElementType() reflect.Type

func (BranchEnvironmentVariableArray) ToBranchEnvironmentVariableArrayOutput 

func (i BranchEnvironmentVariableArray) ToBranchEnvironmentVariableArrayOutput() BranchEnvironmentVariableArrayOutput

func (BranchEnvironmentVariableArray) ToBranchEnvironmentVariableArrayOutputWithContext 

func (i BranchEnvironmentVariableArray) ToBranchEnvironmentVariableArrayOutputWithContext(ctx context.Context) BranchEnvironmentVariableArrayOutput

type BranchEnvironmentVariableArrayInput 

type BranchEnvironmentVariableArrayInput interface {
	pulumi.Input

	ToBranchEnvironmentVariableArrayOutput() BranchEnvironmentVariableArrayOutput
	ToBranchEnvironmentVariableArrayOutputWithContext(context.Context) BranchEnvironmentVariableArrayOutput
}

BranchEnvironmentVariableArrayInput is an input type that accepts BranchEnvironmentVariableArray and BranchEnvironmentVariableArrayOutput values. You can construct a concrete instance of `BranchEnvironmentVariableArrayInput` via: 

BranchEnvironmentVariableArray{ BranchEnvironmentVariableArgs{...} }

type BranchEnvironmentVariableArrayOutput 

type BranchEnvironmentVariableArrayOutput struct{ *pulumi.OutputState }

func (BranchEnvironmentVariableArrayOutput) ElementType 

func (BranchEnvironmentVariableArrayOutput) ElementType() reflect.Type

func (BranchEnvironmentVariableArrayOutput) Index 

func (o BranchEnvironmentVariableArrayOutput) Index(i pulumi.IntInput) BranchEnvironmentVariableOutput

func (BranchEnvironmentVariableArrayOutput) ToBranchEnvironmentVariableArrayOutput 

func (o BranchEnvironmentVariableArrayOutput) ToBranchEnvironmentVariableArrayOutput() BranchEnvironmentVariableArrayOutput

func (BranchEnvironmentVariableArrayOutput) ToBranchEnvironmentVariableArrayOutputWithContext 

func (o BranchEnvironmentVariableArrayOutput) ToBranchEnvironmentVariableArrayOutputWithContext(ctx context.Context) BranchEnvironmentVariableArrayOutput

type BranchEnvironmentVariableInput 

type BranchEnvironmentVariableInput interface {
	pulumi.Input

	ToBranchEnvironmentVariableOutput() BranchEnvironmentVariableOutput
	ToBranchEnvironmentVariableOutputWithContext(context.Context) BranchEnvironmentVariableOutput
}

BranchEnvironmentVariableInput is an input type that accepts BranchEnvironmentVariableArgs and BranchEnvironmentVariableOutput values. You can construct a concrete instance of `BranchEnvironmentVariableInput` via: 

BranchEnvironmentVariableArgs{...}

type BranchEnvironmentVariableOutput 

type BranchEnvironmentVariableOutput struct{ *pulumi.OutputState }

func (BranchEnvironmentVariableOutput) ElementType 

func (BranchEnvironmentVariableOutput) ElementType() reflect.Type

func (BranchEnvironmentVariableOutput) Name 

func (o BranchEnvironmentVariableOutput) Name() pulumi.StringOutput

The environment variable name.

func (BranchEnvironmentVariableOutput) ToBranchEnvironmentVariableOutput 

func (o BranchEnvironmentVariableOutput) ToBranchEnvironmentVariableOutput() BranchEnvironmentVariableOutput

func (BranchEnvironmentVariableOutput) ToBranchEnvironmentVariableOutputWithContext 

func (o BranchEnvironmentVariableOutput) ToBranchEnvironmentVariableOutputWithContext(ctx context.Context) BranchEnvironmentVariableOutput

func (BranchEnvironmentVariableOutput) Value 

func (o BranchEnvironmentVariableOutput) Value() pulumi.StringOutput

The environment variable value.

type BranchInput 

type BranchInput interface {
	pulumi.Input

	ToBranchOutput() BranchOutput
	ToBranchOutputWithContext(ctx context.Context) BranchOutput
}

type BranchOutput 

type BranchOutput struct{ *pulumi.OutputState }

func (BranchOutput) AppId added in v0.17.0 

func (o BranchOutput) AppId() pulumi.StringOutput

The unique ID for an Amplify app.

func (BranchOutput) Arn added in v0.17.0 

func (o BranchOutput) Arn() pulumi.StringOutput

ARN for a branch, part of an Amplify App.

func (BranchOutput) Backend added in v0.83.0 

func (o BranchOutput) Backend() BranchBackendPtrOutput

The backend for a `Branch` of an Amplify app. Use for a backend created from an AWS CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

func (BranchOutput) BasicAuthConfig added in v0.17.0 

func (o BranchOutput) BasicAuthConfig() BranchBasicAuthConfigPtrOutput

The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format `user:password` .

func (BranchOutput) BranchName added in v0.17.0 

func (o BranchOutput) BranchName() pulumi.StringOutput

The name for the branch.

func (BranchOutput) BuildSpec added in v0.17.0 

func (o BranchOutput) BuildSpec() pulumi.StringPtrOutput

The build specification (build spec) for the branch.

func (BranchOutput) Description added in v0.17.0 

func (o BranchOutput) Description() pulumi.StringPtrOutput

The description for the branch that is part of an Amplify app.

func (BranchOutput) ElementType 

func (BranchOutput) ElementType() reflect.Type

func (BranchOutput) EnableAutoBuild added in v0.17.0 

func (o BranchOutput) EnableAutoBuild() pulumi.BoolPtrOutput

Enables auto building for the branch.

func (BranchOutput) EnablePerformanceMode added in v0.17.0 

func (o BranchOutput) EnablePerformanceMode() pulumi.BoolPtrOutput

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

func (BranchOutput) EnablePullRequestPreview added in v0.17.0 

func (o BranchOutput) EnablePullRequestPreview() pulumi.BoolPtrOutput

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.

To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.

For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .

func (BranchOutput) EnvironmentVariables added in v0.17.0 

func (o BranchOutput) EnvironmentVariables() BranchEnvironmentVariableArrayOutput

The environment variables for the branch.

func (BranchOutput) Framework added in v0.41.0 

func (o BranchOutput) Framework() pulumi.StringPtrOutput

The framework for the branch.

func (BranchOutput) PullRequestEnvironmentName added in v0.17.0 

func (o BranchOutput) PullRequestEnvironmentName() pulumi.StringPtrOutput

If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI and mapped to this branch.

To enable pull request previews, set the `EnablePullRequestPreview` property to `true` .

If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed.

For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .

func (BranchOutput) Stage added in v0.17.0 

func (o BranchOutput) Stage() BranchStagePtrOutput

Describes the current stage for the branch.

func (BranchOutput) Tags added in v0.17.0 

func (o BranchOutput) Tags() aws.TagArrayOutput

The tag for the branch.

func (BranchOutput) ToBranchOutput 

func (o BranchOutput) ToBranchOutput() BranchOutput

func (BranchOutput) ToBranchOutputWithContext 

func (o BranchOutput) ToBranchOutputWithContext(ctx context.Context) BranchOutput

type BranchStage 

type BranchStage string

Describes the current stage for the branch.

func (BranchStage) ElementType 

func (BranchStage) ElementType() reflect.Type

func (BranchStage) ToBranchStageOutput 

func (e BranchStage) ToBranchStageOutput() BranchStageOutput

func (BranchStage) ToBranchStageOutputWithContext 

func (e BranchStage) ToBranchStageOutputWithContext(ctx context.Context) BranchStageOutput

func (BranchStage) ToBranchStagePtrOutput 

func (e BranchStage) ToBranchStagePtrOutput() BranchStagePtrOutput

func (BranchStage) ToBranchStagePtrOutputWithContext 

func (e BranchStage) ToBranchStagePtrOutputWithContext(ctx context.Context) BranchStagePtrOutput

func (BranchStage) ToStringOutput 

func (e BranchStage) ToStringOutput() pulumi.StringOutput

func (BranchStage) ToStringOutputWithContext 

func (e BranchStage) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (BranchStage) ToStringPtrOutput 

func (e BranchStage) ToStringPtrOutput() pulumi.StringPtrOutput

func (BranchStage) ToStringPtrOutputWithContext 

func (e BranchStage) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type BranchStageInput 

type BranchStageInput interface {
	pulumi.Input

	ToBranchStageOutput() BranchStageOutput
	ToBranchStageOutputWithContext(context.Context) BranchStageOutput
}

BranchStageInput is an input type that accepts values of the BranchStage enum A concrete instance of `BranchStageInput` can be one of the following: 

BranchStageExperimental
BranchStageBeta
BranchStagePullRequest
BranchStageProduction
BranchStageDevelopment

type BranchStageOutput 

type BranchStageOutput struct{ *pulumi.OutputState }

func (BranchStageOutput) ElementType 

func (BranchStageOutput) ElementType() reflect.Type

func (BranchStageOutput) ToBranchStageOutput 

func (o BranchStageOutput) ToBranchStageOutput() BranchStageOutput

func (BranchStageOutput) ToBranchStageOutputWithContext 

func (o BranchStageOutput) ToBranchStageOutputWithContext(ctx context.Context) BranchStageOutput

func (BranchStageOutput) ToBranchStagePtrOutput 

func (o BranchStageOutput) ToBranchStagePtrOutput() BranchStagePtrOutput

func (BranchStageOutput) ToBranchStagePtrOutputWithContext 

func (o BranchStageOutput) ToBranchStagePtrOutputWithContext(ctx context.Context) BranchStagePtrOutput

func (BranchStageOutput) ToStringOutput 

func (o BranchStageOutput) ToStringOutput() pulumi.StringOutput

func (BranchStageOutput) ToStringOutputWithContext 

func (o BranchStageOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (BranchStageOutput) ToStringPtrOutput 

func (o BranchStageOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (BranchStageOutput) ToStringPtrOutputWithContext 

func (o BranchStageOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type BranchStagePtrInput 

type BranchStagePtrInput interface {
	pulumi.Input

	ToBranchStagePtrOutput() BranchStagePtrOutput
	ToBranchStagePtrOutputWithContext(context.Context) BranchStagePtrOutput
}

func BranchStagePtr 

func BranchStagePtr(v string) BranchStagePtrInput

type BranchStagePtrOutput 

type BranchStagePtrOutput struct{ *pulumi.OutputState }

func (BranchStagePtrOutput) Elem 

func (o BranchStagePtrOutput) Elem() BranchStageOutput

func (BranchStagePtrOutput) ElementType 

func (BranchStagePtrOutput) ElementType() reflect.Type

func (BranchStagePtrOutput) ToBranchStagePtrOutput 

func (o BranchStagePtrOutput) ToBranchStagePtrOutput() BranchStagePtrOutput

func (BranchStagePtrOutput) ToBranchStagePtrOutputWithContext 

func (o BranchStagePtrOutput) ToBranchStagePtrOutputWithContext(ctx context.Context) BranchStagePtrOutput

func (BranchStagePtrOutput) ToStringPtrOutput 

func (o BranchStagePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (BranchStagePtrOutput) ToStringPtrOutputWithContext 

func (o BranchStagePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type BranchState 

type BranchState struct {
}

func (BranchState) ElementType 

func (BranchState) ElementType() reflect.Type

type BranchTag 

type BranchTag struct {
	// Specifies the key for the tag.
	Key string `pulumi:"key"`
	// Specifies the value for the tag.
	Value string `pulumi:"value"`
}

type Domain 

type Domain struct {
	pulumi.CustomResourceState

	// The unique ID for an Amplify app.
	AppId pulumi.StringOutput `pulumi:"appId"`
	// ARN for the Domain Association.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// Sets the branch patterns for automatic subdomain creation.
	AutoSubDomainCreationPatterns pulumi.StringArrayOutput `pulumi:"autoSubDomainCreationPatterns"`
	// The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
	AutoSubDomainIamRole pulumi.StringPtrOutput  `pulumi:"autoSubDomainIamRole"`
	Certificate          DomainCertificateOutput `pulumi:"certificate"`
	// DNS Record for certificate verification.
	CertificateRecord pulumi.StringOutput `pulumi:"certificateRecord"`
	// The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.
	CertificateSettings DomainCertificateSettingsPtrOutput `pulumi:"certificateSettings"`
	// The domain name for the domain association.
	DomainName pulumi.StringOutput `pulumi:"domainName"`
	// Status for the Domain Association.
	DomainStatus pulumi.StringOutput `pulumi:"domainStatus"`
	// Enables the automated creation of subdomains for branches.
	EnableAutoSubDomain pulumi.BoolPtrOutput `pulumi:"enableAutoSubDomain"`
	// Reason for the current status of the domain.
	StatusReason pulumi.StringOutput `pulumi:"statusReason"`
	// The setting for the subdomain.
	SubDomainSettings DomainSubDomainSettingArrayOutput `pulumi:"subDomainSettings"`
	// The status of the domain update operation that is currently in progress. The following list describes the valid update states.
	//
	// - **REQUESTING_CERTIFICATE** - The certificate is in the process of being updated.
	// - **PENDING_VERIFICATION** - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
	// - **IMPORTING_CUSTOM_CERTIFICATE** - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
	// - **PENDING_DEPLOYMENT** - Indicates that the subdomain or certificate changes are being propagated.
	// - **AWAITING_APP_CNAME** - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see [Setting up custom domains](https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html) in the *Amplify Hosting User Guide* .
	// - **UPDATE_COMPLETE** - The certificate has been associated with a domain.
	// - **UPDATE_FAILED** - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
	UpdateStatus pulumi.StringOutput `pulumi:"updateStatus"`
}

The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.

func GetDomain 

func GetDomain(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DomainState, opts ...pulumi.ResourceOption) (*Domain, error)

GetDomain gets an existing Domain resource's state with the given name, ID, and optional state properties that are used to uniquely qualify the lookup (nil if not required).

func NewDomain 

func NewDomain(ctx *pulumi.Context,
	name string, args *DomainArgs, opts ...pulumi.ResourceOption) (*Domain, error)

NewDomain registers a new resource with the given unique name, arguments, and options.

func (*Domain) ElementType 

func (*Domain) ElementType() reflect.Type

func (*Domain) ToDomainOutput 

func (i *Domain) ToDomainOutput() DomainOutput

func (*Domain) ToDomainOutputWithContext 

func (i *Domain) ToDomainOutputWithContext(ctx context.Context) DomainOutput

type DomainArgs 

type DomainArgs struct {
	// The unique ID for an Amplify app.
	AppId pulumi.StringInput
	// Sets the branch patterns for automatic subdomain creation.
	AutoSubDomainCreationPatterns pulumi.StringArrayInput
	// The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
	AutoSubDomainIamRole pulumi.StringPtrInput
	// The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.
	CertificateSettings DomainCertificateSettingsPtrInput
	// The domain name for the domain association.
	DomainName pulumi.StringPtrInput
	// Enables the automated creation of subdomains for branches.
	EnableAutoSubDomain pulumi.BoolPtrInput
	// The setting for the subdomain.
	SubDomainSettings DomainSubDomainSettingArrayInput
}

The set of arguments for constructing a Domain resource.

func (DomainArgs) ElementType 

func (DomainArgs) ElementType() reflect.Type

type DomainCertificate added in v0.98.0 

type DomainCertificate struct {
	// The Amazon resource name (ARN) for a custom certificate that you have already added to AWS Certificate Manager in your AWS account .
	//
	// This field is required only when the certificate type is `CUSTOM` .
	CertificateArn *string `pulumi:"certificateArn"`
	// The type of SSL/TLS certificate that you want to use.
	//
	// Specify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.
	//
	// Specify `CUSTOM` to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .
	CertificateType *DomainCertificateCertificateType `pulumi:"certificateType"`
	// The DNS record for certificate verification.
	CertificateVerificationDnsRecord *string `pulumi:"certificateVerificationDnsRecord"`
}

type DomainCertificateCertificateType added in v0.98.0 

type DomainCertificateCertificateType string

The type of SSL/TLS certificate that you want to use.

Specify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.

Specify `CUSTOM` to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .

type DomainCertificateCertificateTypeOutput added in v0.98.0 

type DomainCertificateCertificateTypeOutput struct{ *pulumi.OutputState }

func (DomainCertificateCertificateTypeOutput) ElementType added in v0.98.0 

func (DomainCertificateCertificateTypeOutput) ElementType() reflect.Type

func (DomainCertificateCertificateTypeOutput) ToDomainCertificateCertificateTypeOutput added in v0.98.0 

func (o DomainCertificateCertificateTypeOutput) ToDomainCertificateCertificateTypeOutput() DomainCertificateCertificateTypeOutput

func (DomainCertificateCertificateTypeOutput) ToDomainCertificateCertificateTypeOutputWithContext added in v0.98.0 

func (o DomainCertificateCertificateTypeOutput) ToDomainCertificateCertificateTypeOutputWithContext(ctx context.Context) DomainCertificateCertificateTypeOutput

func (DomainCertificateCertificateTypeOutput) ToDomainCertificateCertificateTypePtrOutput added in v0.98.0 

func (o DomainCertificateCertificateTypeOutput) ToDomainCertificateCertificateTypePtrOutput() DomainCertificateCertificateTypePtrOutput

func (DomainCertificateCertificateTypeOutput) ToDomainCertificateCertificateTypePtrOutputWithContext added in v0.98.0 

func (o DomainCertificateCertificateTypeOutput) ToDomainCertificateCertificateTypePtrOutputWithContext(ctx context.Context) DomainCertificateCertificateTypePtrOutput

func (DomainCertificateCertificateTypeOutput) ToStringOutput added in v0.98.0 

func (o DomainCertificateCertificateTypeOutput) ToStringOutput() pulumi.StringOutput

func (DomainCertificateCertificateTypeOutput) ToStringOutputWithContext added in v0.98.0 

func (o DomainCertificateCertificateTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DomainCertificateCertificateTypeOutput) ToStringPtrOutput added in v0.98.0 

func (o DomainCertificateCertificateTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DomainCertificateCertificateTypeOutput) ToStringPtrOutputWithContext added in v0.98.0 

func (o DomainCertificateCertificateTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DomainCertificateCertificateTypePtrOutput added in v0.98.0 

type DomainCertificateCertificateTypePtrOutput struct{ *pulumi.OutputState }

func (DomainCertificateCertificateTypePtrOutput) Elem added in v0.98.0 

func (o DomainCertificateCertificateTypePtrOutput) Elem() DomainCertificateCertificateTypeOutput

func (DomainCertificateCertificateTypePtrOutput) ElementType added in v0.98.0 

func (DomainCertificateCertificateTypePtrOutput) ElementType() reflect.Type

func (DomainCertificateCertificateTypePtrOutput) ToDomainCertificateCertificateTypePtrOutput added in v0.98.0 

func (o DomainCertificateCertificateTypePtrOutput) ToDomainCertificateCertificateTypePtrOutput() DomainCertificateCertificateTypePtrOutput

func (DomainCertificateCertificateTypePtrOutput) ToDomainCertificateCertificateTypePtrOutputWithContext added in v0.98.0 

func (o DomainCertificateCertificateTypePtrOutput) ToDomainCertificateCertificateTypePtrOutputWithContext(ctx context.Context) DomainCertificateCertificateTypePtrOutput

func (DomainCertificateCertificateTypePtrOutput) ToStringPtrOutput added in v0.98.0 

func (o DomainCertificateCertificateTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DomainCertificateCertificateTypePtrOutput) ToStringPtrOutputWithContext added in v0.98.0 

func (o DomainCertificateCertificateTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DomainCertificateOutput added in v0.98.0 

type DomainCertificateOutput struct{ *pulumi.OutputState }

func (DomainCertificateOutput) CertificateArn added in v0.98.0 

func (o DomainCertificateOutput) CertificateArn() pulumi.StringPtrOutput

The Amazon resource name (ARN) for a custom certificate that you have already added to AWS Certificate Manager in your AWS account .

This field is required only when the certificate type is `CUSTOM` .

func (DomainCertificateOutput) CertificateType added in v0.98.0 

func (o DomainCertificateOutput) CertificateType() DomainCertificateCertificateTypePtrOutput

The type of SSL/TLS certificate that you want to use.

Specify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.

Specify `CUSTOM` to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .

func (DomainCertificateOutput) CertificateVerificationDnsRecord added in v0.98.0 

func (o DomainCertificateOutput) CertificateVerificationDnsRecord() pulumi.StringPtrOutput

The DNS record for certificate verification.

func (DomainCertificateOutput) ElementType added in v0.98.0 

func (DomainCertificateOutput) ElementType() reflect.Type

func (DomainCertificateOutput) ToDomainCertificateOutput added in v0.98.0 

func (o DomainCertificateOutput) ToDomainCertificateOutput() DomainCertificateOutput

func (DomainCertificateOutput) ToDomainCertificateOutputWithContext added in v0.98.0 

func (o DomainCertificateOutput) ToDomainCertificateOutputWithContext(ctx context.Context) DomainCertificateOutput

type DomainCertificatePtrOutput added in v0.98.0 

type DomainCertificatePtrOutput struct{ *pulumi.OutputState }

func (DomainCertificatePtrOutput) CertificateArn added in v0.98.0 

func (o DomainCertificatePtrOutput) CertificateArn() pulumi.StringPtrOutput

The Amazon resource name (ARN) for a custom certificate that you have already added to AWS Certificate Manager in your AWS account .

This field is required only when the certificate type is `CUSTOM` .

func (DomainCertificatePtrOutput) CertificateType added in v0.98.0 

func (o DomainCertificatePtrOutput) CertificateType() DomainCertificateCertificateTypePtrOutput

The type of SSL/TLS certificate that you want to use.

Specify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.

Specify `CUSTOM` to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .

func (DomainCertificatePtrOutput) CertificateVerificationDnsRecord added in v0.98.0 

func (o DomainCertificatePtrOutput) CertificateVerificationDnsRecord() pulumi.StringPtrOutput

The DNS record for certificate verification.

func (DomainCertificatePtrOutput) Elem added in v0.98.0 

func (o DomainCertificatePtrOutput) Elem() DomainCertificateOutput

func (DomainCertificatePtrOutput) ElementType added in v0.98.0 

func (DomainCertificatePtrOutput) ElementType() reflect.Type

func (DomainCertificatePtrOutput) ToDomainCertificatePtrOutput added in v0.98.0 

func (o DomainCertificatePtrOutput) ToDomainCertificatePtrOutput() DomainCertificatePtrOutput

func (DomainCertificatePtrOutput) ToDomainCertificatePtrOutputWithContext added in v0.98.0 

func (o DomainCertificatePtrOutput) ToDomainCertificatePtrOutputWithContext(ctx context.Context) DomainCertificatePtrOutput

type DomainCertificateSettings added in v0.98.0 

type DomainCertificateSettings struct {
	// The certificate type.
	//
	// Specify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.
	//
	// Specify `CUSTOM` to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .
	CertificateType *DomainCertificateSettingsCertificateType `pulumi:"certificateType"`
	// The Amazon resource name (ARN) for the custom certificate that you have already added to AWS Certificate Manager in your AWS account .
	//
	// This field is required only when the certificate type is `CUSTOM` .
	CustomCertificateArn *string `pulumi:"customCertificateArn"`
}

type DomainCertificateSettingsArgs added in v0.98.0 

type DomainCertificateSettingsArgs struct {
	// The certificate type.
	//
	// Specify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.
	//
	// Specify `CUSTOM` to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .
	CertificateType DomainCertificateSettingsCertificateTypePtrInput `pulumi:"certificateType"`
	// The Amazon resource name (ARN) for the custom certificate that you have already added to AWS Certificate Manager in your AWS account .
	//
	// This field is required only when the certificate type is `CUSTOM` .
	CustomCertificateArn pulumi.StringPtrInput `pulumi:"customCertificateArn"`
}

func (DomainCertificateSettingsArgs) ElementType added in v0.98.0 

func (DomainCertificateSettingsArgs) ElementType() reflect.Type

func (DomainCertificateSettingsArgs) ToDomainCertificateSettingsOutput added in v0.98.0 

func (i DomainCertificateSettingsArgs) ToDomainCertificateSettingsOutput() DomainCertificateSettingsOutput

func (DomainCertificateSettingsArgs) ToDomainCertificateSettingsOutputWithContext added in v0.98.0 

func (i DomainCertificateSettingsArgs) ToDomainCertificateSettingsOutputWithContext(ctx context.Context) DomainCertificateSettingsOutput

func (DomainCertificateSettingsArgs) ToDomainCertificateSettingsPtrOutput added in v0.98.0 

func (i DomainCertificateSettingsArgs) ToDomainCertificateSettingsPtrOutput() DomainCertificateSettingsPtrOutput

func (DomainCertificateSettingsArgs) ToDomainCertificateSettingsPtrOutputWithContext added in v0.98.0 

func (i DomainCertificateSettingsArgs) ToDomainCertificateSettingsPtrOutputWithContext(ctx context.Context) DomainCertificateSettingsPtrOutput

type DomainCertificateSettingsCertificateType added in v0.98.0 

type DomainCertificateSettingsCertificateType string

The certificate type.

Specify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.

Specify `CUSTOM` to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .

func (DomainCertificateSettingsCertificateType) ElementType added in v0.98.0 

func (DomainCertificateSettingsCertificateType) ElementType() reflect.Type

func (DomainCertificateSettingsCertificateType) ToDomainCertificateSettingsCertificateTypeOutput added in v0.98.0 

func (e DomainCertificateSettingsCertificateType) ToDomainCertificateSettingsCertificateTypeOutput() DomainCertificateSettingsCertificateTypeOutput

func (DomainCertificateSettingsCertificateType) ToDomainCertificateSettingsCertificateTypeOutputWithContext added in v0.98.0 

func (e DomainCertificateSettingsCertificateType) ToDomainCertificateSettingsCertificateTypeOutputWithContext(ctx context.Context) DomainCertificateSettingsCertificateTypeOutput

func (DomainCertificateSettingsCertificateType) ToDomainCertificateSettingsCertificateTypePtrOutput added in v0.98.0 

func (e DomainCertificateSettingsCertificateType) ToDomainCertificateSettingsCertificateTypePtrOutput() DomainCertificateSettingsCertificateTypePtrOutput

func (DomainCertificateSettingsCertificateType) ToDomainCertificateSettingsCertificateTypePtrOutputWithContext added in v0.98.0 

func (e DomainCertificateSettingsCertificateType) ToDomainCertificateSettingsCertificateTypePtrOutputWithContext(ctx context.Context) DomainCertificateSettingsCertificateTypePtrOutput

func (DomainCertificateSettingsCertificateType) ToStringOutput added in v0.98.0 

func (e DomainCertificateSettingsCertificateType) ToStringOutput() pulumi.StringOutput

func (DomainCertificateSettingsCertificateType) ToStringOutputWithContext added in v0.98.0 

func (e DomainCertificateSettingsCertificateType) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DomainCertificateSettingsCertificateType) ToStringPtrOutput added in v0.98.0 

func (e DomainCertificateSettingsCertificateType) ToStringPtrOutput() pulumi.StringPtrOutput

func (DomainCertificateSettingsCertificateType) ToStringPtrOutputWithContext added in v0.98.0 

func (e DomainCertificateSettingsCertificateType) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DomainCertificateSettingsCertificateTypeInput added in v0.98.0 

type DomainCertificateSettingsCertificateTypeInput interface {
	pulumi.Input

	ToDomainCertificateSettingsCertificateTypeOutput() DomainCertificateSettingsCertificateTypeOutput
	ToDomainCertificateSettingsCertificateTypeOutputWithContext(context.Context) DomainCertificateSettingsCertificateTypeOutput
}

DomainCertificateSettingsCertificateTypeInput is an input type that accepts values of the DomainCertificateSettingsCertificateType enum A concrete instance of `DomainCertificateSettingsCertificateTypeInput` can be one of the following: 

DomainCertificateSettingsCertificateTypeAmplifyManaged
DomainCertificateSettingsCertificateTypeCustom

type DomainCertificateSettingsCertificateTypeOutput added in v0.98.0 

type DomainCertificateSettingsCertificateTypeOutput struct{ *pulumi.OutputState }

func (DomainCertificateSettingsCertificateTypeOutput) ElementType added in v0.98.0 

func (DomainCertificateSettingsCertificateTypeOutput) ElementType() reflect.Type

func (DomainCertificateSettingsCertificateTypeOutput) ToDomainCertificateSettingsCertificateTypeOutput added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypeOutput) ToDomainCertificateSettingsCertificateTypeOutput() DomainCertificateSettingsCertificateTypeOutput

func (DomainCertificateSettingsCertificateTypeOutput) ToDomainCertificateSettingsCertificateTypeOutputWithContext added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypeOutput) ToDomainCertificateSettingsCertificateTypeOutputWithContext(ctx context.Context) DomainCertificateSettingsCertificateTypeOutput

func (DomainCertificateSettingsCertificateTypeOutput) ToDomainCertificateSettingsCertificateTypePtrOutput added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypeOutput) ToDomainCertificateSettingsCertificateTypePtrOutput() DomainCertificateSettingsCertificateTypePtrOutput

func (DomainCertificateSettingsCertificateTypeOutput) ToDomainCertificateSettingsCertificateTypePtrOutputWithContext added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypeOutput) ToDomainCertificateSettingsCertificateTypePtrOutputWithContext(ctx context.Context) DomainCertificateSettingsCertificateTypePtrOutput

func (DomainCertificateSettingsCertificateTypeOutput) ToStringOutput added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypeOutput) ToStringOutput() pulumi.StringOutput

func (DomainCertificateSettingsCertificateTypeOutput) ToStringOutputWithContext added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypeOutput) ToStringOutputWithContext(ctx context.Context) pulumi.StringOutput

func (DomainCertificateSettingsCertificateTypeOutput) ToStringPtrOutput added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypeOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DomainCertificateSettingsCertificateTypeOutput) ToStringPtrOutputWithContext added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypeOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DomainCertificateSettingsCertificateTypePtrInput added in v0.98.0 

type DomainCertificateSettingsCertificateTypePtrInput interface {
	pulumi.Input

	ToDomainCertificateSettingsCertificateTypePtrOutput() DomainCertificateSettingsCertificateTypePtrOutput
	ToDomainCertificateSettingsCertificateTypePtrOutputWithContext(context.Context) DomainCertificateSettingsCertificateTypePtrOutput
}

func DomainCertificateSettingsCertificateTypePtr added in v0.98.0 

func DomainCertificateSettingsCertificateTypePtr(v string) DomainCertificateSettingsCertificateTypePtrInput

type DomainCertificateSettingsCertificateTypePtrOutput added in v0.98.0 

type DomainCertificateSettingsCertificateTypePtrOutput struct{ *pulumi.OutputState }

func (DomainCertificateSettingsCertificateTypePtrOutput) Elem added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypePtrOutput) Elem() DomainCertificateSettingsCertificateTypeOutput

func (DomainCertificateSettingsCertificateTypePtrOutput) ElementType added in v0.98.0 

func (DomainCertificateSettingsCertificateTypePtrOutput) ElementType() reflect.Type

func (DomainCertificateSettingsCertificateTypePtrOutput) ToDomainCertificateSettingsCertificateTypePtrOutput added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypePtrOutput) ToDomainCertificateSettingsCertificateTypePtrOutput() DomainCertificateSettingsCertificateTypePtrOutput

func (DomainCertificateSettingsCertificateTypePtrOutput) ToDomainCertificateSettingsCertificateTypePtrOutputWithContext added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypePtrOutput) ToDomainCertificateSettingsCertificateTypePtrOutputWithContext(ctx context.Context) DomainCertificateSettingsCertificateTypePtrOutput

func (DomainCertificateSettingsCertificateTypePtrOutput) ToStringPtrOutput added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypePtrOutput) ToStringPtrOutput() pulumi.StringPtrOutput

func (DomainCertificateSettingsCertificateTypePtrOutput) ToStringPtrOutputWithContext added in v0.98.0 

func (o DomainCertificateSettingsCertificateTypePtrOutput) ToStringPtrOutputWithContext(ctx context.Context) pulumi.StringPtrOutput

type DomainCertificateSettingsInput added in v0.98.0 

type DomainCertificateSettingsInput interface {
	pulumi.Input

	ToDomainCertificateSettingsOutput() DomainCertificateSettingsOutput
	ToDomainCertificateSettingsOutputWithContext(context.Context) DomainCertificateSettingsOutput
}

DomainCertificateSettingsInput is an input type that accepts DomainCertificateSettingsArgs and DomainCertificateSettingsOutput values. You can construct a concrete instance of `DomainCertificateSettingsInput` via: 

DomainCertificateSettingsArgs{...}

type DomainCertificateSettingsOutput added in v0.98.0 

type DomainCertificateSettingsOutput struct{ *pulumi.OutputState }

func (DomainCertificateSettingsOutput) CertificateType added in v0.98.0 

func (o DomainCertificateSettingsOutput) CertificateType() DomainCertificateSettingsCertificateTypePtrOutput

The certificate type.

Specify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.

Specify `CUSTOM` to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .

func (DomainCertificateSettingsOutput) CustomCertificateArn added in v0.98.0 

func (o DomainCertificateSettingsOutput) CustomCertificateArn() pulumi.StringPtrOutput

The Amazon resource name (ARN) for the custom certificate that you have already added to AWS Certificate Manager in your AWS account .

This field is required only when the certificate type is `CUSTOM` .

func (DomainCertificateSettingsOutput) ElementType added in v0.98.0 

func (DomainCertificateSettingsOutput) ElementType() reflect.Type

func (DomainCertificateSettingsOutput) ToDomainCertificateSettingsOutput added in v0.98.0 

func (o DomainCertificateSettingsOutput) ToDomainCertificateSettingsOutput() DomainCertificateSettingsOutput

func (DomainCertificateSettingsOutput) ToDomainCertificateSettingsOutputWithContext added in v0.98.0 

func (o DomainCertificateSettingsOutput) ToDomainCertificateSettingsOutputWithContext(ctx context.Context) DomainCertificateSettingsOutput

func (DomainCertificateSettingsOutput) ToDomainCertificateSettingsPtrOutput added in v0.98.0 

func (o DomainCertificateSettingsOutput) ToDomainCertificateSettingsPtrOutput() DomainCertificateSettingsPtrOutput

func (DomainCertificateSettingsOutput) ToDomainCertificateSettingsPtrOutputWithContext added in v0.98.0 

func (o DomainCertificateSettingsOutput) ToDomainCertificateSettingsPtrOutputWithContext(ctx context.Context) DomainCertificateSettingsPtrOutput

type DomainCertificateSettingsPtrInput added in v0.98.0 

type DomainCertificateSettingsPtrInput interface {
	pulumi.Input

	ToDomainCertificateSettingsPtrOutput() DomainCertificateSettingsPtrOutput
	ToDomainCertificateSettingsPtrOutputWithContext(context.Context) DomainCertificateSettingsPtrOutput
}

DomainCertificateSettingsPtrInput is an input type that accepts DomainCertificateSettingsArgs, DomainCertificateSettingsPtr and DomainCertificateSettingsPtrOutput values. You can construct a concrete instance of `DomainCertificateSettingsPtrInput` via: 

        DomainCertificateSettingsArgs{...}

or:

        nil

func DomainCertificateSettingsPtr added in v0.98.0 

func DomainCertificateSettingsPtr(v *DomainCertificateSettingsArgs) DomainCertificateSettingsPtrInput

type DomainCertificateSettingsPtrOutput added in v0.98.0 

type DomainCertificateSettingsPtrOutput struct{ *pulumi.OutputState }

func (DomainCertificateSettingsPtrOutput) CertificateType added in v0.98.0 

func (o DomainCertificateSettingsPtrOutput) CertificateType() DomainCertificateSettingsCertificateTypePtrOutput

The certificate type.

Specify `AMPLIFY_MANAGED` to use the default certificate that Amplify provisions for you.

Specify `CUSTOM` to use your own certificate that you have already added to AWS Certificate Manager in your AWS account . Make sure you request (or import) the certificate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see [Importing certificates into AWS Certificate Manager](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *ACM User guide* .

func (DomainCertificateSettingsPtrOutput) CustomCertificateArn added in v0.98.0 

func (o DomainCertificateSettingsPtrOutput) CustomCertificateArn() pulumi.StringPtrOutput

The Amazon resource name (ARN) for the custom certificate that you have already added to AWS Certificate Manager in your AWS account .

This field is required only when the certificate type is `CUSTOM` .

func (DomainCertificateSettingsPtrOutput) Elem added in v0.98.0 

func (o DomainCertificateSettingsPtrOutput) Elem() DomainCertificateSettingsOutput

func (DomainCertificateSettingsPtrOutput) ElementType added in v0.98.0 

func (DomainCertificateSettingsPtrOutput) ElementType() reflect.Type

func (DomainCertificateSettingsPtrOutput) ToDomainCertificateSettingsPtrOutput added in v0.98.0 

func (o DomainCertificateSettingsPtrOutput) ToDomainCertificateSettingsPtrOutput() DomainCertificateSettingsPtrOutput

func (DomainCertificateSettingsPtrOutput) ToDomainCertificateSettingsPtrOutputWithContext added in v0.98.0 

func (o DomainCertificateSettingsPtrOutput) ToDomainCertificateSettingsPtrOutputWithContext(ctx context.Context) DomainCertificateSettingsPtrOutput

type DomainInput 

type DomainInput interface {
	pulumi.Input

	ToDomainOutput() DomainOutput
	ToDomainOutputWithContext(ctx context.Context) DomainOutput
}

type DomainOutput 

type DomainOutput struct{ *pulumi.OutputState }

func (DomainOutput) AppId added in v0.17.0 

func (o DomainOutput) AppId() pulumi.StringOutput

The unique ID for an Amplify app.

func (DomainOutput) Arn added in v0.17.0 

func (o DomainOutput) Arn() pulumi.StringOutput

ARN for the Domain Association.

func (DomainOutput) AutoSubDomainCreationPatterns added in v0.17.0 

func (o DomainOutput) AutoSubDomainCreationPatterns() pulumi.StringArrayOutput

Sets the branch patterns for automatic subdomain creation.

func (DomainOutput) AutoSubDomainIamRole added in v0.72.0 

func (o DomainOutput) AutoSubDomainIamRole() pulumi.StringPtrOutput

The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

func (DomainOutput) Certificate added in v0.98.0 

func (o DomainOutput) Certificate() DomainCertificateOutput

func (DomainOutput) CertificateRecord added in v0.17.0 

func (o DomainOutput) CertificateRecord() pulumi.StringOutput

DNS Record for certificate verification.

func (DomainOutput) CertificateSettings added in v0.98.0 

func (o DomainOutput) CertificateSettings() DomainCertificateSettingsPtrOutput

The type of SSL/TLS certificate to use for your custom domain. If you don't specify a certificate type, Amplify uses the default certificate that it provisions and manages for you.

func (DomainOutput) DomainName added in v0.17.0 

func (o DomainOutput) DomainName() pulumi.StringOutput

The domain name for the domain association.

func (DomainOutput) DomainStatus added in v0.17.0 

func (o DomainOutput) DomainStatus() pulumi.StringOutput

Status for the Domain Association.

func (DomainOutput) ElementType 

func (DomainOutput) ElementType() reflect.Type

func (DomainOutput) EnableAutoSubDomain added in v0.17.0 

func (o DomainOutput) EnableAutoSubDomain() pulumi.BoolPtrOutput

Enables the automated creation of subdomains for branches.

func (DomainOutput) StatusReason added in v0.17.0 

func (o DomainOutput) StatusReason() pulumi.StringOutput

Reason for the current status of the domain.

func (DomainOutput) SubDomainSettings added in v0.17.0 

func (o DomainOutput) SubDomainSettings() DomainSubDomainSettingArrayOutput

The setting for the subdomain.

func (DomainOutput) ToDomainOutput 

func (o DomainOutput) ToDomainOutput() DomainOutput

func (DomainOutput) ToDomainOutputWithContext 

func (o DomainOutput) ToDomainOutputWithContext(ctx context.Context) DomainOutput

func (DomainOutput) UpdateStatus added in v0.98.0 

func (o DomainOutput) UpdateStatus() pulumi.StringOutput

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

- **REQUESTING_CERTIFICATE** - The certificate is in the process of being updated. - **PENDING_VERIFICATION** - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate. - **IMPORTING_CUSTOM_CERTIFICATE** - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate. - **PENDING_DEPLOYMENT** - Indicates that the subdomain or certificate changes are being propagated. - **AWAITING_APP_CNAME** - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see [Setting up custom domains](https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html) in the *Amplify Hosting User Guide* . - **UPDATE_COMPLETE** - The certificate has been associated with a domain. - **UPDATE_FAILED** - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

type DomainState 

type DomainState struct {
}

func (DomainState) ElementType 

func (DomainState) ElementType() reflect.Type

type DomainSubDomainSetting 

type DomainSubDomainSetting struct {
	// The branch name setting for the subdomain.
	//
	// *Length Constraints:* Minimum length of 1. Maximum length of 255.
	//
	// *Pattern:* (?s).+
	BranchName string `pulumi:"branchName"`
	// The prefix setting for the subdomain.
	Prefix string `pulumi:"prefix"`
}

type DomainSubDomainSettingArgs 

type DomainSubDomainSettingArgs struct {
	// The branch name setting for the subdomain.
	//
	// *Length Constraints:* Minimum length of 1. Maximum length of 255.
	//
	// *Pattern:* (?s).+
	BranchName pulumi.StringInput `pulumi:"branchName"`
	// The prefix setting for the subdomain.
	Prefix pulumi.StringInput `pulumi:"prefix"`
}

func (DomainSubDomainSettingArgs) ElementType 

func (DomainSubDomainSettingArgs) ElementType() reflect.Type

func (DomainSubDomainSettingArgs) ToDomainSubDomainSettingOutput 

func (i DomainSubDomainSettingArgs) ToDomainSubDomainSettingOutput() DomainSubDomainSettingOutput

func (DomainSubDomainSettingArgs) ToDomainSubDomainSettingOutputWithContext 

func (i DomainSubDomainSettingArgs) ToDomainSubDomainSettingOutputWithContext(ctx context.Context) DomainSubDomainSettingOutput

type DomainSubDomainSettingArray 

type DomainSubDomainSettingArray []DomainSubDomainSettingInput

func (DomainSubDomainSettingArray) ElementType 

func (DomainSubDomainSettingArray) ElementType() reflect.Type

func (DomainSubDomainSettingArray) ToDomainSubDomainSettingArrayOutput 

func (i DomainSubDomainSettingArray) ToDomainSubDomainSettingArrayOutput() DomainSubDomainSettingArrayOutput

func (DomainSubDomainSettingArray) ToDomainSubDomainSettingArrayOutputWithContext 

func (i DomainSubDomainSettingArray) ToDomainSubDomainSettingArrayOutputWithContext(ctx context.Context) DomainSubDomainSettingArrayOutput

type DomainSubDomainSettingArrayInput 

type DomainSubDomainSettingArrayInput interface {
	pulumi.Input

	ToDomainSubDomainSettingArrayOutput() DomainSubDomainSettingArrayOutput
	ToDomainSubDomainSettingArrayOutputWithContext(context.Context) DomainSubDomainSettingArrayOutput
}

DomainSubDomainSettingArrayInput is an input type that accepts DomainSubDomainSettingArray and DomainSubDomainSettingArrayOutput values. You can construct a concrete instance of `DomainSubDomainSettingArrayInput` via: 

DomainSubDomainSettingArray{ DomainSubDomainSettingArgs{...} }

type DomainSubDomainSettingArrayOutput 

type DomainSubDomainSettingArrayOutput struct{ *pulumi.OutputState }

func (DomainSubDomainSettingArrayOutput) ElementType 

func (DomainSubDomainSettingArrayOutput) ElementType() reflect.Type

func (DomainSubDomainSettingArrayOutput) Index 

func (o DomainSubDomainSettingArrayOutput) Index(i pulumi.IntInput) DomainSubDomainSettingOutput

func (DomainSubDomainSettingArrayOutput) ToDomainSubDomainSettingArrayOutput 

func (o DomainSubDomainSettingArrayOutput) ToDomainSubDomainSettingArrayOutput() DomainSubDomainSettingArrayOutput

func (DomainSubDomainSettingArrayOutput) ToDomainSubDomainSettingArrayOutputWithContext 

func (o DomainSubDomainSettingArrayOutput) ToDomainSubDomainSettingArrayOutputWithContext(ctx context.Context) DomainSubDomainSettingArrayOutput

type DomainSubDomainSettingInput 

type DomainSubDomainSettingInput interface {
	pulumi.Input

	ToDomainSubDomainSettingOutput() DomainSubDomainSettingOutput
	ToDomainSubDomainSettingOutputWithContext(context.Context) DomainSubDomainSettingOutput
}

DomainSubDomainSettingInput is an input type that accepts DomainSubDomainSettingArgs and DomainSubDomainSettingOutput values. You can construct a concrete instance of `DomainSubDomainSettingInput` via: 

DomainSubDomainSettingArgs{...}

type DomainSubDomainSettingOutput 

type DomainSubDomainSettingOutput struct{ *pulumi.OutputState }

func (DomainSubDomainSettingOutput) BranchName 

func (o DomainSubDomainSettingOutput) BranchName() pulumi.StringOutput

The branch name setting for the subdomain.

*Length Constraints:* Minimum length of 1. Maximum length of 255.

*Pattern:* (?s).+

func (DomainSubDomainSettingOutput) ElementType 

func (DomainSubDomainSettingOutput) ElementType() reflect.Type

func (DomainSubDomainSettingOutput) Prefix 

func (o DomainSubDomainSettingOutput) Prefix() pulumi.StringOutput

The prefix setting for the subdomain.

func (DomainSubDomainSettingOutput) ToDomainSubDomainSettingOutput 

func (o DomainSubDomainSettingOutput) ToDomainSubDomainSettingOutput() DomainSubDomainSettingOutput

func (DomainSubDomainSettingOutput) ToDomainSubDomainSettingOutputWithContext 

func (o DomainSubDomainSettingOutput) ToDomainSubDomainSettingOutputWithContext(ctx context.Context) DomainSubDomainSettingOutput

type LookupAppArgs added in v0.12.0 

type LookupAppArgs struct {
	// ARN for the Amplify App.
	Arn string `pulumi:"arn"`
}

type LookupAppOutputArgs added in v0.12.0 

type LookupAppOutputArgs struct {
	// ARN for the Amplify App.
	Arn pulumi.StringInput `pulumi:"arn"`
}

func (LookupAppOutputArgs) ElementType added in v0.12.0 

func (LookupAppOutputArgs) ElementType() reflect.Type

type LookupAppResult added in v0.12.0 

type LookupAppResult struct {
	// Unique Id for the Amplify App.
	AppId *string `pulumi:"appId"`
	// Name for the Amplify App.
	AppName *string `pulumi:"appName"`
	// ARN for the Amplify App.
	Arn *string `pulumi:"arn"`
	// The build specification (build spec) for an Amplify app.
	BuildSpec *string `pulumi:"buildSpec"`
	// The cache configuration for the Amplify app. If you don't specify the cache configuration `type` , Amplify uses the default `AMPLIFY_MANAGED` setting.
	CacheConfig *AppCacheConfig `pulumi:"cacheConfig"`
	// The custom HTTP headers for an Amplify app.
	CustomHeaders *string `pulumi:"customHeaders"`
	// The custom rewrite and redirect rules for an Amplify app.
	CustomRules []AppCustomRule `pulumi:"customRules"`
	// Default domain for the Amplify App.
	DefaultDomain *string `pulumi:"defaultDomain"`
	// The description of the Amplify app.
	Description *string `pulumi:"description"`
	// Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.
	EnableBranchAutoDeletion *bool `pulumi:"enableBranchAutoDeletion"`
	// The environment variables for the Amplify app.
	//
	// For a list of the environment variables that are accessible to Amplify by default, see [Amplify Environment variables](https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html) in the *Amplify Hosting User Guide* .
	EnvironmentVariables []AppEnvironmentVariable `pulumi:"environmentVariables"`
	// AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.
	IamServiceRole *string `pulumi:"iamServiceRole"`
	// The name of the Amplify app.
	Name *string `pulumi:"name"`
	// The platform for the Amplify app. For a static app, set the platform type to `WEB` . For a dynamic server-side rendered (SSR) app, set the platform type to `WEB_COMPUTE` . For an app requiring Amplify Hosting's original SSR support only, set the platform type to `WEB_DYNAMIC` .
	//
	// If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to `WEB_COMPUTE` and set the artifacts `baseDirectory` to `.next` in the application's build settings. For an example of the build specification settings, see [Amplify build settings for a Next.js 14 SSG application](https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14) in the *Amplify Hosting User Guide* .
	Platform *AppPlatform `pulumi:"platform"`
	// The Git repository for the Amplify app.
	Repository *string `pulumi:"repository"`
	// The tag for an Amplify app.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupApp added in v0.12.0 

func LookupApp(ctx *pulumi.Context, args *LookupAppArgs, opts ...pulumi.InvokeOption) (*LookupAppResult, error)

The AWS::Amplify::App resource creates Apps in the Amplify Console. An App is a collection of branches.

type LookupAppResultOutput added in v0.12.0 

type LookupAppResultOutput struct{ *pulumi.OutputState }

func LookupAppOutput added in v0.12.0 

func LookupAppOutput(ctx *pulumi.Context, args LookupAppOutputArgs, opts ...pulumi.InvokeOption) LookupAppResultOutput

func (LookupAppResultOutput) AppId added in v0.12.0 

func (o LookupAppResultOutput) AppId() pulumi.StringPtrOutput

Unique Id for the Amplify App.

func (LookupAppResultOutput) AppName added in v0.12.0 

func (o LookupAppResultOutput) AppName() pulumi.StringPtrOutput

Name for the Amplify App.

func (LookupAppResultOutput) Arn added in v0.12.0 

func (o LookupAppResultOutput) Arn() pulumi.StringPtrOutput

ARN for the Amplify App.

func (LookupAppResultOutput) BuildSpec added in v0.12.0 

func (o LookupAppResultOutput) BuildSpec() pulumi.StringPtrOutput

The build specification (build spec) for an Amplify app.

func (LookupAppResultOutput) CacheConfig added in v0.122.0 

func (o LookupAppResultOutput) CacheConfig() AppCacheConfigPtrOutput

The cache configuration for the Amplify app. If you don't specify the cache configuration `type` , Amplify uses the default `AMPLIFY_MANAGED` setting.

func (LookupAppResultOutput) CustomHeaders added in v0.12.0 

func (o LookupAppResultOutput) CustomHeaders() pulumi.StringPtrOutput

The custom HTTP headers for an Amplify app.

func (LookupAppResultOutput) CustomRules added in v0.12.0 

func (o LookupAppResultOutput) CustomRules() AppCustomRuleArrayOutput

The custom rewrite and redirect rules for an Amplify app.

func (LookupAppResultOutput) DefaultDomain added in v0.12.0 

func (o LookupAppResultOutput) DefaultDomain() pulumi.StringPtrOutput

Default domain for the Amplify App.

func (LookupAppResultOutput) Description added in v0.12.0 

func (o LookupAppResultOutput) Description() pulumi.StringPtrOutput

The description of the Amplify app.

func (LookupAppResultOutput) ElementType added in v0.12.0 

func (LookupAppResultOutput) ElementType() reflect.Type

func (LookupAppResultOutput) EnableBranchAutoDeletion added in v0.12.0 

func (o LookupAppResultOutput) EnableBranchAutoDeletion() pulumi.BoolPtrOutput

Automatically disconnect a branch in Amplify Hosting when you delete a branch from your Git repository.

func (LookupAppResultOutput) EnvironmentVariables added in v0.12.0 

func (o LookupAppResultOutput) EnvironmentVariables() AppEnvironmentVariableArrayOutput

The environment variables for the Amplify app.

For a list of the environment variables that are accessible to Amplify by default, see [Amplify Environment variables](https://docs.aws.amazon.com/amplify/latest/userguide/amplify-console-environment-variables.html) in the *Amplify Hosting User Guide* .

func (LookupAppResultOutput) IamServiceRole added in v0.72.0 

func (o LookupAppResultOutput) IamServiceRole() pulumi.StringPtrOutput

AWS Identity and Access Management ( IAM ) service role for the Amazon Resource Name (ARN) of the Amplify app.

func (LookupAppResultOutput) Name added in v0.12.0 

func (o LookupAppResultOutput) Name() pulumi.StringPtrOutput

The name of the Amplify app.

func (LookupAppResultOutput) Platform added in v0.41.0 

func (o LookupAppResultOutput) Platform() AppPlatformPtrOutput

The platform for the Amplify app. For a static app, set the platform type to `WEB` . For a dynamic server-side rendered (SSR) app, set the platform type to `WEB_COMPUTE` . For an app requiring Amplify Hosting's original SSR support only, set the platform type to `WEB_DYNAMIC` .

If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to `WEB_COMPUTE` and set the artifacts `baseDirectory` to `.next` in the application's build settings. For an example of the build specification settings, see [Amplify build settings for a Next.js 14 SSG application](https://docs.aws.amazon.com/amplify/latest/userguide/deploy-nextjs-app.html#build-setting-detection-ssg-14) in the *Amplify Hosting User Guide* .

func (LookupAppResultOutput) Repository added in v0.12.0 

func (o LookupAppResultOutput) Repository() pulumi.StringPtrOutput

The Git repository for the Amplify app.

func (LookupAppResultOutput) Tags added in v0.12.0 

func (o LookupAppResultOutput) Tags() aws.TagArrayOutput

The tag for an Amplify app.

func (LookupAppResultOutput) ToLookupAppResultOutput added in v0.12.0 

func (o LookupAppResultOutput) ToLookupAppResultOutput() LookupAppResultOutput

func (LookupAppResultOutput) ToLookupAppResultOutputWithContext added in v0.12.0 

func (o LookupAppResultOutput) ToLookupAppResultOutputWithContext(ctx context.Context) LookupAppResultOutput

type LookupBranchArgs added in v0.12.0 

type LookupBranchArgs struct {
	// ARN for a branch, part of an Amplify App.
	Arn string `pulumi:"arn"`
}

type LookupBranchOutputArgs added in v0.12.0 

type LookupBranchOutputArgs struct {
	// ARN for a branch, part of an Amplify App.
	Arn pulumi.StringInput `pulumi:"arn"`
}

func (LookupBranchOutputArgs) ElementType added in v0.12.0 

func (LookupBranchOutputArgs) ElementType() reflect.Type

type LookupBranchResult added in v0.12.0 

type LookupBranchResult struct {
	// ARN for a branch, part of an Amplify App.
	Arn *string `pulumi:"arn"`
	// The backend for a `Branch` of an Amplify app. Use for a backend created from an AWS CloudFormation stack.
	//
	// This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.
	Backend *BranchBackend `pulumi:"backend"`
	// The build specification (build spec) for the branch.
	BuildSpec *string `pulumi:"buildSpec"`
	// The description for the branch that is part of an Amplify app.
	Description *string `pulumi:"description"`
	// Enables auto building for the branch.
	EnableAutoBuild *bool `pulumi:"enableAutoBuild"`
	// Enables performance mode for the branch.
	//
	// Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
	EnablePerformanceMode *bool `pulumi:"enablePerformanceMode"`
	// Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.
	//
	// To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.
	//
	// For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .
	EnablePullRequestPreview *bool `pulumi:"enablePullRequestPreview"`
	// The environment variables for the branch.
	EnvironmentVariables []BranchEnvironmentVariable `pulumi:"environmentVariables"`
	// The framework for the branch.
	Framework *string `pulumi:"framework"`
	// If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI and mapped to this branch.
	//
	// To enable pull request previews, set the `EnablePullRequestPreview` property to `true` .
	//
	// If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed.
	//
	// For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .
	PullRequestEnvironmentName *string `pulumi:"pullRequestEnvironmentName"`
	// Describes the current stage for the branch.
	Stage *BranchStage `pulumi:"stage"`
	// The tag for the branch.
	Tags []aws.Tag `pulumi:"tags"`
}

func LookupBranch added in v0.12.0 

func LookupBranch(ctx *pulumi.Context, args *LookupBranchArgs, opts ...pulumi.InvokeOption) (*LookupBranchResult, error)

The AWS::Amplify::Branch resource creates a new branch within an app.

type LookupBranchResultOutput added in v0.12.0 

type LookupBranchResultOutput struct{ *pulumi.OutputState }

func LookupBranchOutput added in v0.12.0 

func LookupBranchOutput(ctx *pulumi.Context, args LookupBranchOutputArgs, opts ...pulumi.InvokeOption) LookupBranchResultOutput

func (LookupBranchResultOutput) Arn added in v0.12.0 

func (o LookupBranchResultOutput) Arn() pulumi.StringPtrOutput

ARN for a branch, part of an Amplify App.

func (LookupBranchResultOutput) Backend added in v0.83.0 

func (o LookupBranchResultOutput) Backend() BranchBackendPtrOutput

The backend for a `Branch` of an Amplify app. Use for a backend created from an AWS CloudFormation stack.

This field is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code.

func (LookupBranchResultOutput) BuildSpec added in v0.12.0 

func (o LookupBranchResultOutput) BuildSpec() pulumi.StringPtrOutput

The build specification (build spec) for the branch.

func (LookupBranchResultOutput) Description added in v0.12.0 

func (o LookupBranchResultOutput) Description() pulumi.StringPtrOutput

The description for the branch that is part of an Amplify app.

func (LookupBranchResultOutput) ElementType added in v0.12.0 

func (LookupBranchResultOutput) ElementType() reflect.Type

func (LookupBranchResultOutput) EnableAutoBuild added in v0.12.0 

func (o LookupBranchResultOutput) EnableAutoBuild() pulumi.BoolPtrOutput

Enables auto building for the branch.

func (LookupBranchResultOutput) EnablePerformanceMode added in v0.12.0 

func (o LookupBranchResultOutput) EnablePerformanceMode() pulumi.BoolPtrOutput

Enables performance mode for the branch.

Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.

func (LookupBranchResultOutput) EnablePullRequestPreview added in v0.12.0 

func (o LookupBranchResultOutput) EnablePullRequestPreview() pulumi.BoolPtrOutput

Specifies whether Amplify Hosting creates a preview for each pull request that is made for this branch. If this property is enabled, Amplify deploys your app to a unique preview URL after each pull request is opened. Development and QA teams can use this preview to test the pull request before it's merged into a production or integration branch.

To provide backend support for your preview, Amplify automatically provisions a temporary backend environment that it deletes when the pull request is closed. If you want to specify a dedicated backend environment for your previews, use the `PullRequestEnvironmentName` property.

For more information, see [Web Previews](https://docs.aws.amazon.com/amplify/latest/userguide/pr-previews.html) in the *AWS Amplify Hosting User Guide* .

func (LookupBranchResultOutput) EnvironmentVariables added in v0.12.0 

func (o LookupBranchResultOutput) EnvironmentVariables() BranchEnvironmentVariableArrayOutput

The environment variables for the branch.

func (LookupBranchResultOutput) Framework added in v0.41.0 

func (o LookupBranchResultOutput) Framework() pulumi.StringPtrOutput

The framework for the branch.

func (LookupBranchResultOutput) PullRequestEnvironmentName added in v0.12.0 

func (o LookupBranchResultOutput) PullRequestEnvironmentName() pulumi.StringPtrOutput

If pull request previews are enabled for this branch, you can use this property to specify a dedicated backend environment for your previews. For example, you could specify an environment named `prod` , `test` , or `dev` that you initialized with the Amplify CLI and mapped to this branch.

To enable pull request previews, set the `EnablePullRequestPreview` property to `true` .

If you don't specify an environment, Amplify Hosting provides backend support for each preview by automatically provisioning a temporary backend environment. Amplify Hosting deletes this environment when the pull request is closed.

For more information about creating backend environments, see [Feature Branch Deployments and Team Workflows](https://docs.aws.amazon.com/amplify/latest/userguide/multi-environments.html) in the *AWS Amplify Hosting User Guide* .

func (LookupBranchResultOutput) Stage added in v0.12.0 

func (o LookupBranchResultOutput) Stage() BranchStagePtrOutput

Describes the current stage for the branch.

func (LookupBranchResultOutput) Tags added in v0.12.0 

func (o LookupBranchResultOutput) Tags() aws.TagArrayOutput

The tag for the branch.

func (LookupBranchResultOutput) ToLookupBranchResultOutput added in v0.12.0 

func (o LookupBranchResultOutput) ToLookupBranchResultOutput() LookupBranchResultOutput

func (LookupBranchResultOutput) ToLookupBranchResultOutputWithContext added in v0.12.0 

func (o LookupBranchResultOutput) ToLookupBranchResultOutputWithContext(ctx context.Context) LookupBranchResultOutput

type LookupDomainArgs added in v0.12.0 

type LookupDomainArgs struct {
	// ARN for the Domain Association.
	Arn string `pulumi:"arn"`
}

type LookupDomainOutputArgs added in v0.12.0 

type LookupDomainOutputArgs struct {
	// ARN for the Domain Association.
	Arn pulumi.StringInput `pulumi:"arn"`
}

func (LookupDomainOutputArgs) ElementType added in v0.12.0 

func (LookupDomainOutputArgs) ElementType() reflect.Type

type LookupDomainResult added in v0.12.0 

type LookupDomainResult struct {
	// ARN for the Domain Association.
	Arn *string `pulumi:"arn"`
	// Sets the branch patterns for automatic subdomain creation.
	AutoSubDomainCreationPatterns []string `pulumi:"autoSubDomainCreationPatterns"`
	// The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.
	AutoSubDomainIamRole *string            `pulumi:"autoSubDomainIamRole"`
	Certificate          *DomainCertificate `pulumi:"certificate"`
	// DNS Record for certificate verification.
	CertificateRecord *string `pulumi:"certificateRecord"`
	// Status for the Domain Association.
	DomainStatus *string `pulumi:"domainStatus"`
	// Enables the automated creation of subdomains for branches.
	EnableAutoSubDomain *bool `pulumi:"enableAutoSubDomain"`
	// Reason for the current status of the domain.
	StatusReason *string `pulumi:"statusReason"`
	// The setting for the subdomain.
	SubDomainSettings []DomainSubDomainSetting `pulumi:"subDomainSettings"`
	// The status of the domain update operation that is currently in progress. The following list describes the valid update states.
	//
	// - **REQUESTING_CERTIFICATE** - The certificate is in the process of being updated.
	// - **PENDING_VERIFICATION** - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate.
	// - **IMPORTING_CUSTOM_CERTIFICATE** - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate.
	// - **PENDING_DEPLOYMENT** - Indicates that the subdomain or certificate changes are being propagated.
	// - **AWAITING_APP_CNAME** - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see [Setting up custom domains](https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html) in the *Amplify Hosting User Guide* .
	// - **UPDATE_COMPLETE** - The certificate has been associated with a domain.
	// - **UPDATE_FAILED** - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.
	UpdateStatus *string `pulumi:"updateStatus"`
}

func LookupDomain added in v0.12.0 

func LookupDomain(ctx *pulumi.Context, args *LookupDomainArgs, opts ...pulumi.InvokeOption) (*LookupDomainResult, error)

The AWS::Amplify::Domain resource allows you to connect a custom domain to your app.

type LookupDomainResultOutput added in v0.12.0 

type LookupDomainResultOutput struct{ *pulumi.OutputState }

func LookupDomainOutput added in v0.12.0 

func LookupDomainOutput(ctx *pulumi.Context, args LookupDomainOutputArgs, opts ...pulumi.InvokeOption) LookupDomainResultOutput

func (LookupDomainResultOutput) Arn added in v0.12.0 

func (o LookupDomainResultOutput) Arn() pulumi.StringPtrOutput

ARN for the Domain Association.

func (LookupDomainResultOutput) AutoSubDomainCreationPatterns added in v0.12.0 

func (o LookupDomainResultOutput) AutoSubDomainCreationPatterns() pulumi.StringArrayOutput

Sets the branch patterns for automatic subdomain creation.

func (LookupDomainResultOutput) AutoSubDomainIamRole added in v0.72.0 

func (o LookupDomainResultOutput) AutoSubDomainIamRole() pulumi.StringPtrOutput

The required AWS Identity and Access Management (IAMlong) service role for the Amazon Resource Name (ARN) for automatically creating subdomains.

func (LookupDomainResultOutput) Certificate added in v0.98.0 

func (o LookupDomainResultOutput) Certificate() DomainCertificatePtrOutput

func (LookupDomainResultOutput) CertificateRecord added in v0.12.0 

func (o LookupDomainResultOutput) CertificateRecord() pulumi.StringPtrOutput

DNS Record for certificate verification.

func (LookupDomainResultOutput) DomainStatus added in v0.12.0 

func (o LookupDomainResultOutput) DomainStatus() pulumi.StringPtrOutput

Status for the Domain Association.

func (LookupDomainResultOutput) ElementType added in v0.12.0 

func (LookupDomainResultOutput) ElementType() reflect.Type

func (LookupDomainResultOutput) EnableAutoSubDomain added in v0.12.0 

func (o LookupDomainResultOutput) EnableAutoSubDomain() pulumi.BoolPtrOutput

Enables the automated creation of subdomains for branches.

func (LookupDomainResultOutput) StatusReason added in v0.12.0 

func (o LookupDomainResultOutput) StatusReason() pulumi.StringPtrOutput

Reason for the current status of the domain.

func (LookupDomainResultOutput) SubDomainSettings added in v0.12.0 

func (o LookupDomainResultOutput) SubDomainSettings() DomainSubDomainSettingArrayOutput

The setting for the subdomain.

func (LookupDomainResultOutput) ToLookupDomainResultOutput added in v0.12.0 

func (o LookupDomainResultOutput) ToLookupDomainResultOutput() LookupDomainResultOutput

func (LookupDomainResultOutput) ToLookupDomainResultOutputWithContext added in v0.12.0 

func (o LookupDomainResultOutput) ToLookupDomainResultOutputWithContext(ctx context.Context) LookupDomainResultOutput

func (LookupDomainResultOutput) UpdateStatus added in v0.98.0 

func (o LookupDomainResultOutput) UpdateStatus() pulumi.StringPtrOutput

The status of the domain update operation that is currently in progress. The following list describes the valid update states.

- **REQUESTING_CERTIFICATE** - The certificate is in the process of being updated. - **PENDING_VERIFICATION** - Indicates that an Amplify managed certificate is in the process of being verified. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certificate. - **IMPORTING_CUSTOM_CERTIFICATE** - Indicates that an Amplify custom certificate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certificate. - **PENDING_DEPLOYMENT** - Indicates that the subdomain or certificate changes are being propagated. - **AWAITING_APP_CNAME** - Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see [Setting up custom domains](https://docs.aws.amazon.com/amplify/latest/userguide/custom-domains.html) in the *Amplify Hosting User Guide* . - **UPDATE_COMPLETE** - The certificate has been associated with a domain. - **UPDATE_FAILED** - The certificate has failed to be provisioned or associated, and there is no existing active certificate to roll back to.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.