amplify

package
v4.37.1 Latest Latest
Warning

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

Go to latest
Published: Feb 1, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type App

type App struct {
	pulumi.CustomResourceState

	// The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.
	AccessToken pulumi.StringPtrOutput `pulumi:"accessToken"`
	// The Amazon Resource Name (ARN) of the Amplify app.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The automated branch creation configuration for an Amplify app. An `autoBranchCreationConfig` block is documented below.
	AutoBranchCreationConfig AppAutoBranchCreationConfigOutput `pulumi:"autoBranchCreationConfig"`
	// The automated branch creation glob patterns for an Amplify app.
	AutoBranchCreationPatterns pulumi.StringArrayOutput `pulumi:"autoBranchCreationPatterns"`
	// The credentials for basic authorization for an Amplify app.
	BasicAuthCredentials pulumi.StringPtrOutput `pulumi:"basicAuthCredentials"`
	// The [build specification](https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html) (build spec) for an Amplify app.
	BuildSpec pulumi.StringOutput `pulumi:"buildSpec"`
	// The custom rewrite and redirect rules for an Amplify app. A `customRule` block is documented below.
	CustomRules AppCustomRuleArrayOutput `pulumi:"customRules"`
	// The default domain for the Amplify app.
	DefaultDomain pulumi.StringOutput `pulumi:"defaultDomain"`
	// The description for an Amplify app.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// Enables automated branch creation for an Amplify app.
	EnableAutoBranchCreation pulumi.BoolPtrOutput `pulumi:"enableAutoBranchCreation"`
	// Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
	EnableBasicAuth pulumi.BoolPtrOutput `pulumi:"enableBasicAuth"`
	// Enables auto-building of branches for the Amplify App.
	EnableBranchAutoBuild pulumi.BoolPtrOutput `pulumi:"enableBranchAutoBuild"`
	// Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
	EnableBranchAutoDeletion pulumi.BoolPtrOutput `pulumi:"enableBranchAutoDeletion"`
	// The environment variables map for an Amplify app.
	EnvironmentVariables pulumi.StringMapOutput `pulumi:"environmentVariables"`
	// The AWS Identity and Access Management (IAM) service role for an Amplify app.
	IamServiceRoleArn pulumi.StringPtrOutput `pulumi:"iamServiceRoleArn"`
	// The name for an 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. The OAuth token is not stored.
	OauthToken pulumi.StringPtrOutput `pulumi:"oauthToken"`
	// The platform or framework for an Amplify app. Valid values: `WEB`.
	Platform pulumi.StringPtrOutput `pulumi:"platform"`
	// Describes the information about a production branch for an Amplify app. A `productionBranch` block is documented below.
	ProductionBranches AppProductionBranchArrayOutput `pulumi:"productionBranches"`
	// The repository for an Amplify app.
	Repository pulumi.StringPtrOutput `pulumi:"repository"`
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
}

## Import

Amplify App can be imported using Amplify App ID (appId), e.g.,

```sh

$ pulumi import aws:amplify/app:App example d2ypk4k47z8u6

```

App ID can be obtained from App ARN (e.g., `arn:aws:amplify:us-east-1:12345678:apps/d2ypk4k47z8u6`).

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

func (*App) ToAppPtrOutput

func (i *App) ToAppPtrOutput() AppPtrOutput

func (*App) ToAppPtrOutputWithContext

func (i *App) ToAppPtrOutputWithContext(ctx context.Context) AppPtrOutput

type AppArgs

type AppArgs struct {
	// The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.
	AccessToken pulumi.StringPtrInput
	// The automated branch creation configuration for an Amplify app. An `autoBranchCreationConfig` block is documented below.
	AutoBranchCreationConfig AppAutoBranchCreationConfigPtrInput
	// The automated branch creation glob patterns for an Amplify app.
	AutoBranchCreationPatterns pulumi.StringArrayInput
	// The credentials for basic authorization for an Amplify app.
	BasicAuthCredentials pulumi.StringPtrInput
	// The [build specification](https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html) (build spec) for an Amplify app.
	BuildSpec pulumi.StringPtrInput
	// The custom rewrite and redirect rules for an Amplify app. A `customRule` block is documented below.
	CustomRules AppCustomRuleArrayInput
	// The description for an Amplify app.
	Description pulumi.StringPtrInput
	// Enables automated branch creation for an Amplify app.
	EnableAutoBranchCreation pulumi.BoolPtrInput
	// Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
	EnableBasicAuth pulumi.BoolPtrInput
	// Enables auto-building of branches for the Amplify App.
	EnableBranchAutoBuild pulumi.BoolPtrInput
	// Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
	EnableBranchAutoDeletion pulumi.BoolPtrInput
	// The environment variables map for an Amplify app.
	EnvironmentVariables pulumi.StringMapInput
	// The AWS Identity and Access Management (IAM) service role for an Amplify app.
	IamServiceRoleArn pulumi.StringPtrInput
	// The name for an 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. The OAuth token is not stored.
	OauthToken pulumi.StringPtrInput
	// The platform or framework for an Amplify app. Valid values: `WEB`.
	Platform pulumi.StringPtrInput
	// The repository for an Amplify app.
	Repository pulumi.StringPtrInput
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
}

The set of arguments for constructing a App resource.

func (AppArgs) ElementType

func (AppArgs) ElementType() reflect.Type

type AppArray

type AppArray []AppInput

func (AppArray) ElementType

func (AppArray) ElementType() reflect.Type

func (AppArray) ToAppArrayOutput

func (i AppArray) ToAppArrayOutput() AppArrayOutput

func (AppArray) ToAppArrayOutputWithContext

func (i AppArray) ToAppArrayOutputWithContext(ctx context.Context) AppArrayOutput

type AppArrayInput

type AppArrayInput interface {
	pulumi.Input

	ToAppArrayOutput() AppArrayOutput
	ToAppArrayOutputWithContext(context.Context) AppArrayOutput
}

AppArrayInput is an input type that accepts AppArray and AppArrayOutput values. You can construct a concrete instance of `AppArrayInput` via:

AppArray{ AppArgs{...} }

type AppArrayOutput

type AppArrayOutput struct{ *pulumi.OutputState }

func (AppArrayOutput) ElementType

func (AppArrayOutput) ElementType() reflect.Type

func (AppArrayOutput) Index

func (AppArrayOutput) ToAppArrayOutput

func (o AppArrayOutput) ToAppArrayOutput() AppArrayOutput

func (AppArrayOutput) ToAppArrayOutputWithContext

func (o AppArrayOutput) ToAppArrayOutputWithContext(ctx context.Context) AppArrayOutput

type AppAutoBranchCreationConfig

type AppAutoBranchCreationConfig struct {
	// The basic authorization credentials for the autocreated branch.
	BasicAuthCredentials *string `pulumi:"basicAuthCredentials"`
	// The build specification (build spec) for the autocreated branch.
	BuildSpec *string `pulumi:"buildSpec"`
	// Enables auto building for the autocreated branch.
	EnableAutoBuild *bool `pulumi:"enableAutoBuild"`
	// Enables basic authorization for the autocreated branch.
	EnableBasicAuth *bool `pulumi:"enableBasicAuth"`
	// Enables performance mode for the branch.
	EnablePerformanceMode *bool `pulumi:"enablePerformanceMode"`
	// Enables pull request previews for the autocreated branch.
	EnablePullRequestPreview *bool `pulumi:"enablePullRequestPreview"`
	// The environment variables for the autocreated branch.
	EnvironmentVariables map[string]string `pulumi:"environmentVariables"`
	// The framework for the autocreated branch.
	Framework *string `pulumi:"framework"`
	// The Amplify environment name for the pull request.
	PullRequestEnvironmentName *string `pulumi:"pullRequestEnvironmentName"`
	// Describes the current stage for the autocreated branch. Valid values: `PRODUCTION`, `BETA`, `DEVELOPMENT`, `EXPERIMENTAL`, `PULL_REQUEST`.
	Stage *string `pulumi:"stage"`
}

type AppAutoBranchCreationConfigArgs

type AppAutoBranchCreationConfigArgs struct {
	// The basic authorization credentials for the autocreated branch.
	BasicAuthCredentials pulumi.StringPtrInput `pulumi:"basicAuthCredentials"`
	// The build specification (build spec) for the autocreated branch.
	BuildSpec pulumi.StringPtrInput `pulumi:"buildSpec"`
	// Enables auto building for the autocreated branch.
	EnableAutoBuild pulumi.BoolPtrInput `pulumi:"enableAutoBuild"`
	// Enables basic authorization for the autocreated branch.
	EnableBasicAuth pulumi.BoolPtrInput `pulumi:"enableBasicAuth"`
	// Enables performance mode for the branch.
	EnablePerformanceMode pulumi.BoolPtrInput `pulumi:"enablePerformanceMode"`
	// Enables pull request previews for the autocreated branch.
	EnablePullRequestPreview pulumi.BoolPtrInput `pulumi:"enablePullRequestPreview"`
	// The environment variables for the autocreated branch.
	EnvironmentVariables pulumi.StringMapInput `pulumi:"environmentVariables"`
	// The framework for the autocreated branch.
	Framework pulumi.StringPtrInput `pulumi:"framework"`
	// The Amplify environment name for the pull request.
	PullRequestEnvironmentName pulumi.StringPtrInput `pulumi:"pullRequestEnvironmentName"`
	// Describes the current stage for the autocreated branch. Valid values: `PRODUCTION`, `BETA`, `DEVELOPMENT`, `EXPERIMENTAL`, `PULL_REQUEST`.
	Stage pulumi.StringPtrInput `pulumi:"stage"`
}

func (AppAutoBranchCreationConfigArgs) ElementType

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) BasicAuthCredentials

func (o AppAutoBranchCreationConfigOutput) BasicAuthCredentials() pulumi.StringPtrOutput

The basic authorization credentials for the autocreated branch.

func (AppAutoBranchCreationConfigOutput) BuildSpec

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

func (AppAutoBranchCreationConfigOutput) ElementType

func (AppAutoBranchCreationConfigOutput) EnableAutoBuild

Enables auto building for the autocreated branch.

func (AppAutoBranchCreationConfigOutput) EnableBasicAuth

Enables basic authorization for the autocreated branch.

func (AppAutoBranchCreationConfigOutput) EnablePerformanceMode

func (o AppAutoBranchCreationConfigOutput) EnablePerformanceMode() pulumi.BoolPtrOutput

Enables performance mode for the branch.

func (AppAutoBranchCreationConfigOutput) EnablePullRequestPreview

func (o AppAutoBranchCreationConfigOutput) EnablePullRequestPreview() pulumi.BoolPtrOutput

Enables pull request previews for the autocreated branch.

func (AppAutoBranchCreationConfigOutput) EnvironmentVariables

func (o AppAutoBranchCreationConfigOutput) EnvironmentVariables() pulumi.StringMapOutput

The environment variables for the autocreated branch.

func (AppAutoBranchCreationConfigOutput) Framework

The framework for the autocreated branch.

func (AppAutoBranchCreationConfigOutput) PullRequestEnvironmentName

func (o AppAutoBranchCreationConfigOutput) PullRequestEnvironmentName() pulumi.StringPtrOutput

The Amplify environment name for the pull request.

func (AppAutoBranchCreationConfigOutput) Stage

Describes the current stage for the autocreated branch. Valid values: `PRODUCTION`, `BETA`, `DEVELOPMENT`, `EXPERIMENTAL`, `PULL_REQUEST`.

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

type AppAutoBranchCreationConfigPtrOutput

type AppAutoBranchCreationConfigPtrOutput struct{ *pulumi.OutputState }

func (AppAutoBranchCreationConfigPtrOutput) BasicAuthCredentials

The basic authorization credentials for the autocreated branch.

func (AppAutoBranchCreationConfigPtrOutput) BuildSpec

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

func (AppAutoBranchCreationConfigPtrOutput) Elem

func (AppAutoBranchCreationConfigPtrOutput) ElementType

func (AppAutoBranchCreationConfigPtrOutput) EnableAutoBuild

Enables auto building for the autocreated branch.

func (AppAutoBranchCreationConfigPtrOutput) EnableBasicAuth

Enables basic authorization for the autocreated branch.

func (AppAutoBranchCreationConfigPtrOutput) EnablePerformanceMode

func (o AppAutoBranchCreationConfigPtrOutput) EnablePerformanceMode() pulumi.BoolPtrOutput

Enables performance mode for the branch.

func (AppAutoBranchCreationConfigPtrOutput) EnablePullRequestPreview

func (o AppAutoBranchCreationConfigPtrOutput) EnablePullRequestPreview() pulumi.BoolPtrOutput

Enables pull request previews for the autocreated branch.

func (AppAutoBranchCreationConfigPtrOutput) EnvironmentVariables

The environment variables for the autocreated branch.

func (AppAutoBranchCreationConfigPtrOutput) Framework

The framework for the autocreated branch.

func (AppAutoBranchCreationConfigPtrOutput) PullRequestEnvironmentName

func (o AppAutoBranchCreationConfigPtrOutput) PullRequestEnvironmentName() pulumi.StringPtrOutput

The Amplify environment name for the pull request.

func (AppAutoBranchCreationConfigPtrOutput) Stage

Describes the current stage for the autocreated branch. Valid values: `PRODUCTION`, `BETA`, `DEVELOPMENT`, `EXPERIMENTAL`, `PULL_REQUEST`.

func (AppAutoBranchCreationConfigPtrOutput) ToAppAutoBranchCreationConfigPtrOutput

func (o AppAutoBranchCreationConfigPtrOutput) ToAppAutoBranchCreationConfigPtrOutput() AppAutoBranchCreationConfigPtrOutput

func (AppAutoBranchCreationConfigPtrOutput) ToAppAutoBranchCreationConfigPtrOutputWithContext

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

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. Valid values: `200`, `301`, `302`, `404`, `404-200`.
	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. Valid values: `200`, `301`, `302`, `404`, `404-200`.
	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 (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

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

The source pattern for a URL rewrite or redirect rule.

func (AppCustomRuleOutput) Status

The status code for a URL rewrite or redirect rule. Valid values: `200`, `301`, `302`, `404`, `404-200`.

func (AppCustomRuleOutput) Target

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 AppInput

type AppInput interface {
	pulumi.Input

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

type AppMap

type AppMap map[string]AppInput

func (AppMap) ElementType

func (AppMap) ElementType() reflect.Type

func (AppMap) ToAppMapOutput

func (i AppMap) ToAppMapOutput() AppMapOutput

func (AppMap) ToAppMapOutputWithContext

func (i AppMap) ToAppMapOutputWithContext(ctx context.Context) AppMapOutput

type AppMapInput

type AppMapInput interface {
	pulumi.Input

	ToAppMapOutput() AppMapOutput
	ToAppMapOutputWithContext(context.Context) AppMapOutput
}

AppMapInput is an input type that accepts AppMap and AppMapOutput values. You can construct a concrete instance of `AppMapInput` via:

AppMap{ "key": AppArgs{...} }

type AppMapOutput

type AppMapOutput struct{ *pulumi.OutputState }

func (AppMapOutput) ElementType

func (AppMapOutput) ElementType() reflect.Type

func (AppMapOutput) MapIndex

func (o AppMapOutput) MapIndex(k pulumi.StringInput) AppOutput

func (AppMapOutput) ToAppMapOutput

func (o AppMapOutput) ToAppMapOutput() AppMapOutput

func (AppMapOutput) ToAppMapOutputWithContext

func (o AppMapOutput) ToAppMapOutputWithContext(ctx context.Context) AppMapOutput

type AppOutput

type AppOutput struct{ *pulumi.OutputState }

func (AppOutput) ElementType

func (AppOutput) ElementType() reflect.Type

func (AppOutput) ToAppOutput

func (o AppOutput) ToAppOutput() AppOutput

func (AppOutput) ToAppOutputWithContext

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

func (AppOutput) ToAppPtrOutput

func (o AppOutput) ToAppPtrOutput() AppPtrOutput

func (AppOutput) ToAppPtrOutputWithContext

func (o AppOutput) ToAppPtrOutputWithContext(ctx context.Context) AppPtrOutput

type AppProductionBranch

type AppProductionBranch struct {
	// The branch name for the production branch.
	BranchName *string `pulumi:"branchName"`
	// The last deploy time of the production branch.
	LastDeployTime *string `pulumi:"lastDeployTime"`
	// The status code for a URL rewrite or redirect rule. Valid values: `200`, `301`, `302`, `404`, `404-200`.
	Status *string `pulumi:"status"`
	// The thumbnail URL for the production branch.
	ThumbnailUrl *string `pulumi:"thumbnailUrl"`
}

type AppProductionBranchArgs

type AppProductionBranchArgs struct {
	// The branch name for the production branch.
	BranchName pulumi.StringPtrInput `pulumi:"branchName"`
	// The last deploy time of the production branch.
	LastDeployTime pulumi.StringPtrInput `pulumi:"lastDeployTime"`
	// The status code for a URL rewrite or redirect rule. Valid values: `200`, `301`, `302`, `404`, `404-200`.
	Status pulumi.StringPtrInput `pulumi:"status"`
	// The thumbnail URL for the production branch.
	ThumbnailUrl pulumi.StringPtrInput `pulumi:"thumbnailUrl"`
}

func (AppProductionBranchArgs) ElementType

func (AppProductionBranchArgs) ElementType() reflect.Type

func (AppProductionBranchArgs) ToAppProductionBranchOutput

func (i AppProductionBranchArgs) ToAppProductionBranchOutput() AppProductionBranchOutput

func (AppProductionBranchArgs) ToAppProductionBranchOutputWithContext

func (i AppProductionBranchArgs) ToAppProductionBranchOutputWithContext(ctx context.Context) AppProductionBranchOutput

type AppProductionBranchArray

type AppProductionBranchArray []AppProductionBranchInput

func (AppProductionBranchArray) ElementType

func (AppProductionBranchArray) ElementType() reflect.Type

func (AppProductionBranchArray) ToAppProductionBranchArrayOutput

func (i AppProductionBranchArray) ToAppProductionBranchArrayOutput() AppProductionBranchArrayOutput

func (AppProductionBranchArray) ToAppProductionBranchArrayOutputWithContext

func (i AppProductionBranchArray) ToAppProductionBranchArrayOutputWithContext(ctx context.Context) AppProductionBranchArrayOutput

type AppProductionBranchArrayInput

type AppProductionBranchArrayInput interface {
	pulumi.Input

	ToAppProductionBranchArrayOutput() AppProductionBranchArrayOutput
	ToAppProductionBranchArrayOutputWithContext(context.Context) AppProductionBranchArrayOutput
}

AppProductionBranchArrayInput is an input type that accepts AppProductionBranchArray and AppProductionBranchArrayOutput values. You can construct a concrete instance of `AppProductionBranchArrayInput` via:

AppProductionBranchArray{ AppProductionBranchArgs{...} }

type AppProductionBranchArrayOutput

type AppProductionBranchArrayOutput struct{ *pulumi.OutputState }

func (AppProductionBranchArrayOutput) ElementType

func (AppProductionBranchArrayOutput) Index

func (AppProductionBranchArrayOutput) ToAppProductionBranchArrayOutput

func (o AppProductionBranchArrayOutput) ToAppProductionBranchArrayOutput() AppProductionBranchArrayOutput

func (AppProductionBranchArrayOutput) ToAppProductionBranchArrayOutputWithContext

func (o AppProductionBranchArrayOutput) ToAppProductionBranchArrayOutputWithContext(ctx context.Context) AppProductionBranchArrayOutput

type AppProductionBranchInput

type AppProductionBranchInput interface {
	pulumi.Input

	ToAppProductionBranchOutput() AppProductionBranchOutput
	ToAppProductionBranchOutputWithContext(context.Context) AppProductionBranchOutput
}

AppProductionBranchInput is an input type that accepts AppProductionBranchArgs and AppProductionBranchOutput values. You can construct a concrete instance of `AppProductionBranchInput` via:

AppProductionBranchArgs{...}

type AppProductionBranchOutput

type AppProductionBranchOutput struct{ *pulumi.OutputState }

func (AppProductionBranchOutput) BranchName

The branch name for the production branch.

func (AppProductionBranchOutput) ElementType

func (AppProductionBranchOutput) ElementType() reflect.Type

func (AppProductionBranchOutput) LastDeployTime

The last deploy time of the production branch.

func (AppProductionBranchOutput) Status

The status code for a URL rewrite or redirect rule. Valid values: `200`, `301`, `302`, `404`, `404-200`.

func (AppProductionBranchOutput) ThumbnailUrl

The thumbnail URL for the production branch.

func (AppProductionBranchOutput) ToAppProductionBranchOutput

func (o AppProductionBranchOutput) ToAppProductionBranchOutput() AppProductionBranchOutput

func (AppProductionBranchOutput) ToAppProductionBranchOutputWithContext

func (o AppProductionBranchOutput) ToAppProductionBranchOutputWithContext(ctx context.Context) AppProductionBranchOutput

type AppPtrInput

type AppPtrInput interface {
	pulumi.Input

	ToAppPtrOutput() AppPtrOutput
	ToAppPtrOutputWithContext(ctx context.Context) AppPtrOutput
}

type AppPtrOutput

type AppPtrOutput struct{ *pulumi.OutputState }

func (AppPtrOutput) Elem added in v4.15.0

func (o AppPtrOutput) Elem() AppOutput

func (AppPtrOutput) ElementType

func (AppPtrOutput) ElementType() reflect.Type

func (AppPtrOutput) ToAppPtrOutput

func (o AppPtrOutput) ToAppPtrOutput() AppPtrOutput

func (AppPtrOutput) ToAppPtrOutputWithContext

func (o AppPtrOutput) ToAppPtrOutputWithContext(ctx context.Context) AppPtrOutput

type AppState

type AppState struct {
	// The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored.
	AccessToken pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) of the Amplify app.
	Arn pulumi.StringPtrInput
	// The automated branch creation configuration for an Amplify app. An `autoBranchCreationConfig` block is documented below.
	AutoBranchCreationConfig AppAutoBranchCreationConfigPtrInput
	// The automated branch creation glob patterns for an Amplify app.
	AutoBranchCreationPatterns pulumi.StringArrayInput
	// The credentials for basic authorization for an Amplify app.
	BasicAuthCredentials pulumi.StringPtrInput
	// The [build specification](https://docs.aws.amazon.com/amplify/latest/userguide/build-settings.html) (build spec) for an Amplify app.
	BuildSpec pulumi.StringPtrInput
	// The custom rewrite and redirect rules for an Amplify app. A `customRule` block is documented below.
	CustomRules AppCustomRuleArrayInput
	// The default domain for the Amplify app.
	DefaultDomain pulumi.StringPtrInput
	// The description for an Amplify app.
	Description pulumi.StringPtrInput
	// Enables automated branch creation for an Amplify app.
	EnableAutoBranchCreation pulumi.BoolPtrInput
	// Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app.
	EnableBasicAuth pulumi.BoolPtrInput
	// Enables auto-building of branches for the Amplify App.
	EnableBranchAutoBuild pulumi.BoolPtrInput
	// Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository.
	EnableBranchAutoDeletion pulumi.BoolPtrInput
	// The environment variables map for an Amplify app.
	EnvironmentVariables pulumi.StringMapInput
	// The AWS Identity and Access Management (IAM) service role for an Amplify app.
	IamServiceRoleArn pulumi.StringPtrInput
	// The name for an 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. The OAuth token is not stored.
	OauthToken pulumi.StringPtrInput
	// The platform or framework for an Amplify app. Valid values: `WEB`.
	Platform pulumi.StringPtrInput
	// Describes the information about a production branch for an Amplify app. A `productionBranch` block is documented below.
	ProductionBranches AppProductionBranchArrayInput
	// The repository for an Amplify app.
	Repository pulumi.StringPtrInput
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapInput
}

func (AppState) ElementType

func (AppState) ElementType() reflect.Type

type BackendEnvironment

type BackendEnvironment struct {
	pulumi.CustomResourceState

	// The unique ID for an Amplify app.
	AppId pulumi.StringOutput `pulumi:"appId"`
	// The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The name of deployment artifacts.
	DeploymentArtifacts pulumi.StringOutput `pulumi:"deploymentArtifacts"`
	// The name for the backend environment.
	EnvironmentName pulumi.StringOutput `pulumi:"environmentName"`
	// The AWS CloudFormation stack name of a backend environment.
	StackName pulumi.StringOutput `pulumi:"stackName"`
}

Provides an Amplify Backend Environment resource.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleApp, err := amplify.NewApp(ctx, "exampleApp", nil)
		if err != nil {
			return err
		}
		_, err = amplify.NewBackendEnvironment(ctx, "exampleBackendEnvironment", &amplify.BackendEnvironmentArgs{
			AppId:               exampleApp.ID(),
			EnvironmentName:     pulumi.String("example"),
			DeploymentArtifacts: pulumi.String("app-example-deployment"),
			StackName:           pulumi.String("amplify-app-example"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Amplify backend environment can be imported using `app_id` and `environment_name`, e.g.,

```sh

$ pulumi import aws:amplify/backendEnvironment:BackendEnvironment example d2ypk4k47z8u6/example

```

func GetBackendEnvironment

func GetBackendEnvironment(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *BackendEnvironmentState, opts ...pulumi.ResourceOption) (*BackendEnvironment, error)

GetBackendEnvironment gets an existing BackendEnvironment 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 NewBackendEnvironment

func NewBackendEnvironment(ctx *pulumi.Context,
	name string, args *BackendEnvironmentArgs, opts ...pulumi.ResourceOption) (*BackendEnvironment, error)

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

func (*BackendEnvironment) ElementType

func (*BackendEnvironment) ElementType() reflect.Type

func (*BackendEnvironment) ToBackendEnvironmentOutput

func (i *BackendEnvironment) ToBackendEnvironmentOutput() BackendEnvironmentOutput

func (*BackendEnvironment) ToBackendEnvironmentOutputWithContext

func (i *BackendEnvironment) ToBackendEnvironmentOutputWithContext(ctx context.Context) BackendEnvironmentOutput

func (*BackendEnvironment) ToBackendEnvironmentPtrOutput

func (i *BackendEnvironment) ToBackendEnvironmentPtrOutput() BackendEnvironmentPtrOutput

func (*BackendEnvironment) ToBackendEnvironmentPtrOutputWithContext

func (i *BackendEnvironment) ToBackendEnvironmentPtrOutputWithContext(ctx context.Context) BackendEnvironmentPtrOutput

type BackendEnvironmentArgs

type BackendEnvironmentArgs struct {
	// The unique ID for an Amplify app.
	AppId pulumi.StringInput
	// The name of deployment artifacts.
	DeploymentArtifacts pulumi.StringPtrInput
	// The name for the backend environment.
	EnvironmentName pulumi.StringInput
	// The AWS CloudFormation stack name of a backend environment.
	StackName pulumi.StringPtrInput
}

The set of arguments for constructing a BackendEnvironment resource.

func (BackendEnvironmentArgs) ElementType

func (BackendEnvironmentArgs) ElementType() reflect.Type

type BackendEnvironmentArray

type BackendEnvironmentArray []BackendEnvironmentInput

func (BackendEnvironmentArray) ElementType

func (BackendEnvironmentArray) ElementType() reflect.Type

func (BackendEnvironmentArray) ToBackendEnvironmentArrayOutput

func (i BackendEnvironmentArray) ToBackendEnvironmentArrayOutput() BackendEnvironmentArrayOutput

func (BackendEnvironmentArray) ToBackendEnvironmentArrayOutputWithContext

func (i BackendEnvironmentArray) ToBackendEnvironmentArrayOutputWithContext(ctx context.Context) BackendEnvironmentArrayOutput

type BackendEnvironmentArrayInput

type BackendEnvironmentArrayInput interface {
	pulumi.Input

	ToBackendEnvironmentArrayOutput() BackendEnvironmentArrayOutput
	ToBackendEnvironmentArrayOutputWithContext(context.Context) BackendEnvironmentArrayOutput
}

BackendEnvironmentArrayInput is an input type that accepts BackendEnvironmentArray and BackendEnvironmentArrayOutput values. You can construct a concrete instance of `BackendEnvironmentArrayInput` via:

BackendEnvironmentArray{ BackendEnvironmentArgs{...} }

type BackendEnvironmentArrayOutput

type BackendEnvironmentArrayOutput struct{ *pulumi.OutputState }

func (BackendEnvironmentArrayOutput) ElementType

func (BackendEnvironmentArrayOutput) Index

func (BackendEnvironmentArrayOutput) ToBackendEnvironmentArrayOutput

func (o BackendEnvironmentArrayOutput) ToBackendEnvironmentArrayOutput() BackendEnvironmentArrayOutput

func (BackendEnvironmentArrayOutput) ToBackendEnvironmentArrayOutputWithContext

func (o BackendEnvironmentArrayOutput) ToBackendEnvironmentArrayOutputWithContext(ctx context.Context) BackendEnvironmentArrayOutput

type BackendEnvironmentInput

type BackendEnvironmentInput interface {
	pulumi.Input

	ToBackendEnvironmentOutput() BackendEnvironmentOutput
	ToBackendEnvironmentOutputWithContext(ctx context.Context) BackendEnvironmentOutput
}

type BackendEnvironmentMap

type BackendEnvironmentMap map[string]BackendEnvironmentInput

func (BackendEnvironmentMap) ElementType

func (BackendEnvironmentMap) ElementType() reflect.Type

func (BackendEnvironmentMap) ToBackendEnvironmentMapOutput

func (i BackendEnvironmentMap) ToBackendEnvironmentMapOutput() BackendEnvironmentMapOutput

func (BackendEnvironmentMap) ToBackendEnvironmentMapOutputWithContext

func (i BackendEnvironmentMap) ToBackendEnvironmentMapOutputWithContext(ctx context.Context) BackendEnvironmentMapOutput

type BackendEnvironmentMapInput

type BackendEnvironmentMapInput interface {
	pulumi.Input

	ToBackendEnvironmentMapOutput() BackendEnvironmentMapOutput
	ToBackendEnvironmentMapOutputWithContext(context.Context) BackendEnvironmentMapOutput
}

BackendEnvironmentMapInput is an input type that accepts BackendEnvironmentMap and BackendEnvironmentMapOutput values. You can construct a concrete instance of `BackendEnvironmentMapInput` via:

BackendEnvironmentMap{ "key": BackendEnvironmentArgs{...} }

type BackendEnvironmentMapOutput

type BackendEnvironmentMapOutput struct{ *pulumi.OutputState }

func (BackendEnvironmentMapOutput) ElementType

func (BackendEnvironmentMapOutput) MapIndex

func (BackendEnvironmentMapOutput) ToBackendEnvironmentMapOutput

func (o BackendEnvironmentMapOutput) ToBackendEnvironmentMapOutput() BackendEnvironmentMapOutput

func (BackendEnvironmentMapOutput) ToBackendEnvironmentMapOutputWithContext

func (o BackendEnvironmentMapOutput) ToBackendEnvironmentMapOutputWithContext(ctx context.Context) BackendEnvironmentMapOutput

type BackendEnvironmentOutput

type BackendEnvironmentOutput struct{ *pulumi.OutputState }

func (BackendEnvironmentOutput) ElementType

func (BackendEnvironmentOutput) ElementType() reflect.Type

func (BackendEnvironmentOutput) ToBackendEnvironmentOutput

func (o BackendEnvironmentOutput) ToBackendEnvironmentOutput() BackendEnvironmentOutput

func (BackendEnvironmentOutput) ToBackendEnvironmentOutputWithContext

func (o BackendEnvironmentOutput) ToBackendEnvironmentOutputWithContext(ctx context.Context) BackendEnvironmentOutput

func (BackendEnvironmentOutput) ToBackendEnvironmentPtrOutput

func (o BackendEnvironmentOutput) ToBackendEnvironmentPtrOutput() BackendEnvironmentPtrOutput

func (BackendEnvironmentOutput) ToBackendEnvironmentPtrOutputWithContext

func (o BackendEnvironmentOutput) ToBackendEnvironmentPtrOutputWithContext(ctx context.Context) BackendEnvironmentPtrOutput

type BackendEnvironmentPtrInput

type BackendEnvironmentPtrInput interface {
	pulumi.Input

	ToBackendEnvironmentPtrOutput() BackendEnvironmentPtrOutput
	ToBackendEnvironmentPtrOutputWithContext(ctx context.Context) BackendEnvironmentPtrOutput
}

type BackendEnvironmentPtrOutput

type BackendEnvironmentPtrOutput struct{ *pulumi.OutputState }

func (BackendEnvironmentPtrOutput) Elem added in v4.15.0

func (BackendEnvironmentPtrOutput) ElementType

func (BackendEnvironmentPtrOutput) ToBackendEnvironmentPtrOutput

func (o BackendEnvironmentPtrOutput) ToBackendEnvironmentPtrOutput() BackendEnvironmentPtrOutput

func (BackendEnvironmentPtrOutput) ToBackendEnvironmentPtrOutputWithContext

func (o BackendEnvironmentPtrOutput) ToBackendEnvironmentPtrOutputWithContext(ctx context.Context) BackendEnvironmentPtrOutput

type BackendEnvironmentState

type BackendEnvironmentState struct {
	// The unique ID for an Amplify app.
	AppId pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
	Arn pulumi.StringPtrInput
	// The name of deployment artifacts.
	DeploymentArtifacts pulumi.StringPtrInput
	// The name for the backend environment.
	EnvironmentName pulumi.StringPtrInput
	// The AWS CloudFormation stack name of a backend environment.
	StackName pulumi.StringPtrInput
}

func (BackendEnvironmentState) ElementType

func (BackendEnvironmentState) ElementType() reflect.Type

type Branch

type Branch struct {
	pulumi.CustomResourceState

	// The unique ID for an Amplify app.
	AppId pulumi.StringOutput `pulumi:"appId"`
	// The Amazon Resource Name (ARN) for the branch.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// A list of custom resources that are linked to this branch.
	AssociatedResources pulumi.StringArrayOutput `pulumi:"associatedResources"`
	// The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
	BackendEnvironmentArn pulumi.StringPtrOutput `pulumi:"backendEnvironmentArn"`
	// The basic authorization credentials for the branch.
	BasicAuthCredentials pulumi.StringPtrOutput `pulumi:"basicAuthCredentials"`
	// The name for the branch.
	BranchName pulumi.StringOutput `pulumi:"branchName"`
	// The custom domains for the branch.
	CustomDomains pulumi.StringArrayOutput `pulumi:"customDomains"`
	// The description for the branch.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The destination branch if the branch is a pull request branch.
	DestinationBranch pulumi.StringOutput `pulumi:"destinationBranch"`
	// The display name for a branch. This is used as the default domain prefix.
	DisplayName pulumi.StringOutput `pulumi:"displayName"`
	// Enables auto building for the branch.
	EnableAutoBuild pulumi.BoolPtrOutput `pulumi:"enableAutoBuild"`
	// Enables basic authorization for the branch.
	EnableBasicAuth pulumi.BoolPtrOutput `pulumi:"enableBasicAuth"`
	// Enables notifications for the branch.
	EnableNotification pulumi.BoolPtrOutput `pulumi:"enableNotification"`
	// Enables performance mode for the branch.
	EnablePerformanceMode pulumi.BoolPtrOutput `pulumi:"enablePerformanceMode"`
	// Enables pull request previews for this branch.
	EnablePullRequestPreview pulumi.BoolPtrOutput `pulumi:"enablePullRequestPreview"`
	// The environment variables for the branch.
	EnvironmentVariables pulumi.StringMapOutput `pulumi:"environmentVariables"`
	// The framework for the branch.
	Framework pulumi.StringPtrOutput `pulumi:"framework"`
	// The Amplify environment name for the pull request.
	PullRequestEnvironmentName pulumi.StringPtrOutput `pulumi:"pullRequestEnvironmentName"`
	// The source branch if the branch is a pull request branch.
	SourceBranch pulumi.StringOutput `pulumi:"sourceBranch"`
	// Describes the current stage for the branch. Valid values: `PRODUCTION`, `BETA`, `DEVELOPMENT`, `EXPERIMENTAL`, `PULL_REQUEST`.
	Stage pulumi.StringPtrOutput `pulumi:"stage"`
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapOutput `pulumi:"tags"`
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapOutput `pulumi:"tagsAll"`
	// The content Time To Live (TTL) for the website in seconds.
	Ttl pulumi.StringPtrOutput `pulumi:"ttl"`
}

Provides an Amplify Branch resource.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := amplify.NewApp(ctx, "example", nil)
		if err != nil {
			return err
		}
		_, err = amplify.NewBranch(ctx, "master", &amplify.BranchArgs{
			AppId:      example.ID(),
			BranchName: pulumi.String("master"),
			Framework:  pulumi.String("React"),
			Stage:      pulumi.String("PRODUCTION"),
			EnvironmentVariables: pulumi.StringMap{
				"REACT_APP_API_SERVER": pulumi.String("https://api.example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Amplify branch can be imported using `app_id` and `branch_name`, e.g.,

```sh

$ pulumi import aws:amplify/branch:Branch master d2ypk4k47z8u6/master

```

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

func (*Branch) ToBranchPtrOutput

func (i *Branch) ToBranchPtrOutput() BranchPtrOutput

func (*Branch) ToBranchPtrOutputWithContext

func (i *Branch) ToBranchPtrOutputWithContext(ctx context.Context) BranchPtrOutput

type BranchArgs

type BranchArgs struct {
	// The unique ID for an Amplify app.
	AppId pulumi.StringInput
	// The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
	BackendEnvironmentArn pulumi.StringPtrInput
	// The basic authorization credentials for the branch.
	BasicAuthCredentials pulumi.StringPtrInput
	// The name for the branch.
	BranchName pulumi.StringInput
	// The description for the branch.
	Description pulumi.StringPtrInput
	// The display name for a branch. This is used as the default domain prefix.
	DisplayName pulumi.StringPtrInput
	// Enables auto building for the branch.
	EnableAutoBuild pulumi.BoolPtrInput
	// Enables basic authorization for the branch.
	EnableBasicAuth pulumi.BoolPtrInput
	// Enables notifications for the branch.
	EnableNotification pulumi.BoolPtrInput
	// Enables performance mode for the branch.
	EnablePerformanceMode pulumi.BoolPtrInput
	// Enables pull request previews for this branch.
	EnablePullRequestPreview pulumi.BoolPtrInput
	// The environment variables for the branch.
	EnvironmentVariables pulumi.StringMapInput
	// The framework for the branch.
	Framework pulumi.StringPtrInput
	// The Amplify environment name for the pull request.
	PullRequestEnvironmentName pulumi.StringPtrInput
	// Describes the current stage for the branch. Valid values: `PRODUCTION`, `BETA`, `DEVELOPMENT`, `EXPERIMENTAL`, `PULL_REQUEST`.
	Stage pulumi.StringPtrInput
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// The content Time To Live (TTL) for the website in seconds.
	Ttl pulumi.StringPtrInput
}

The set of arguments for constructing a Branch resource.

func (BranchArgs) ElementType

func (BranchArgs) ElementType() reflect.Type

type BranchArray

type BranchArray []BranchInput

func (BranchArray) ElementType

func (BranchArray) ElementType() reflect.Type

func (BranchArray) ToBranchArrayOutput

func (i BranchArray) ToBranchArrayOutput() BranchArrayOutput

func (BranchArray) ToBranchArrayOutputWithContext

func (i BranchArray) ToBranchArrayOutputWithContext(ctx context.Context) BranchArrayOutput

type BranchArrayInput

type BranchArrayInput interface {
	pulumi.Input

	ToBranchArrayOutput() BranchArrayOutput
	ToBranchArrayOutputWithContext(context.Context) BranchArrayOutput
}

BranchArrayInput is an input type that accepts BranchArray and BranchArrayOutput values. You can construct a concrete instance of `BranchArrayInput` via:

BranchArray{ BranchArgs{...} }

type BranchArrayOutput

type BranchArrayOutput struct{ *pulumi.OutputState }

func (BranchArrayOutput) ElementType

func (BranchArrayOutput) ElementType() reflect.Type

func (BranchArrayOutput) Index

func (BranchArrayOutput) ToBranchArrayOutput

func (o BranchArrayOutput) ToBranchArrayOutput() BranchArrayOutput

func (BranchArrayOutput) ToBranchArrayOutputWithContext

func (o BranchArrayOutput) ToBranchArrayOutputWithContext(ctx context.Context) BranchArrayOutput

type BranchInput

type BranchInput interface {
	pulumi.Input

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

type BranchMap

type BranchMap map[string]BranchInput

func (BranchMap) ElementType

func (BranchMap) ElementType() reflect.Type

func (BranchMap) ToBranchMapOutput

func (i BranchMap) ToBranchMapOutput() BranchMapOutput

func (BranchMap) ToBranchMapOutputWithContext

func (i BranchMap) ToBranchMapOutputWithContext(ctx context.Context) BranchMapOutput

type BranchMapInput

type BranchMapInput interface {
	pulumi.Input

	ToBranchMapOutput() BranchMapOutput
	ToBranchMapOutputWithContext(context.Context) BranchMapOutput
}

BranchMapInput is an input type that accepts BranchMap and BranchMapOutput values. You can construct a concrete instance of `BranchMapInput` via:

BranchMap{ "key": BranchArgs{...} }

type BranchMapOutput

type BranchMapOutput struct{ *pulumi.OutputState }

func (BranchMapOutput) ElementType

func (BranchMapOutput) ElementType() reflect.Type

func (BranchMapOutput) MapIndex

func (BranchMapOutput) ToBranchMapOutput

func (o BranchMapOutput) ToBranchMapOutput() BranchMapOutput

func (BranchMapOutput) ToBranchMapOutputWithContext

func (o BranchMapOutput) ToBranchMapOutputWithContext(ctx context.Context) BranchMapOutput

type BranchOutput

type BranchOutput struct{ *pulumi.OutputState }

func (BranchOutput) ElementType

func (BranchOutput) ElementType() reflect.Type

func (BranchOutput) ToBranchOutput

func (o BranchOutput) ToBranchOutput() BranchOutput

func (BranchOutput) ToBranchOutputWithContext

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

func (BranchOutput) ToBranchPtrOutput

func (o BranchOutput) ToBranchPtrOutput() BranchPtrOutput

func (BranchOutput) ToBranchPtrOutputWithContext

func (o BranchOutput) ToBranchPtrOutputWithContext(ctx context.Context) BranchPtrOutput

type BranchPtrInput

type BranchPtrInput interface {
	pulumi.Input

	ToBranchPtrOutput() BranchPtrOutput
	ToBranchPtrOutputWithContext(ctx context.Context) BranchPtrOutput
}

type BranchPtrOutput

type BranchPtrOutput struct{ *pulumi.OutputState }

func (BranchPtrOutput) Elem added in v4.15.0

func (o BranchPtrOutput) Elem() BranchOutput

func (BranchPtrOutput) ElementType

func (BranchPtrOutput) ElementType() reflect.Type

func (BranchPtrOutput) ToBranchPtrOutput

func (o BranchPtrOutput) ToBranchPtrOutput() BranchPtrOutput

func (BranchPtrOutput) ToBranchPtrOutputWithContext

func (o BranchPtrOutput) ToBranchPtrOutputWithContext(ctx context.Context) BranchPtrOutput

type BranchState

type BranchState struct {
	// The unique ID for an Amplify app.
	AppId pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) for the branch.
	Arn pulumi.StringPtrInput
	// A list of custom resources that are linked to this branch.
	AssociatedResources pulumi.StringArrayInput
	// The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app.
	BackendEnvironmentArn pulumi.StringPtrInput
	// The basic authorization credentials for the branch.
	BasicAuthCredentials pulumi.StringPtrInput
	// The name for the branch.
	BranchName pulumi.StringPtrInput
	// The custom domains for the branch.
	CustomDomains pulumi.StringArrayInput
	// The description for the branch.
	Description pulumi.StringPtrInput
	// The destination branch if the branch is a pull request branch.
	DestinationBranch pulumi.StringPtrInput
	// The display name for a branch. This is used as the default domain prefix.
	DisplayName pulumi.StringPtrInput
	// Enables auto building for the branch.
	EnableAutoBuild pulumi.BoolPtrInput
	// Enables basic authorization for the branch.
	EnableBasicAuth pulumi.BoolPtrInput
	// Enables notifications for the branch.
	EnableNotification pulumi.BoolPtrInput
	// Enables performance mode for the branch.
	EnablePerformanceMode pulumi.BoolPtrInput
	// Enables pull request previews for this branch.
	EnablePullRequestPreview pulumi.BoolPtrInput
	// The environment variables for the branch.
	EnvironmentVariables pulumi.StringMapInput
	// The framework for the branch.
	Framework pulumi.StringPtrInput
	// The Amplify environment name for the pull request.
	PullRequestEnvironmentName pulumi.StringPtrInput
	// The source branch if the branch is a pull request branch.
	SourceBranch pulumi.StringPtrInput
	// Describes the current stage for the branch. Valid values: `PRODUCTION`, `BETA`, `DEVELOPMENT`, `EXPERIMENTAL`, `PULL_REQUEST`.
	Stage pulumi.StringPtrInput
	// Key-value mapping of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
	Tags pulumi.StringMapInput
	// A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
	TagsAll pulumi.StringMapInput
	// The content Time To Live (TTL) for the website in seconds.
	Ttl pulumi.StringPtrInput
}

func (BranchState) ElementType

func (BranchState) ElementType() reflect.Type

type DomainAssociation

type DomainAssociation struct {
	pulumi.CustomResourceState

	// The unique ID for an Amplify app.
	AppId pulumi.StringOutput `pulumi:"appId"`
	// The Amazon Resource Name (ARN) for the domain association.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The DNS record for certificate verification.
	CertificateVerificationDnsRecord pulumi.StringOutput `pulumi:"certificateVerificationDnsRecord"`
	// The domain name for the domain association.
	DomainName pulumi.StringOutput `pulumi:"domainName"`
	// The setting for the subdomain. Documented below.
	SubDomains DomainAssociationSubDomainArrayOutput `pulumi:"subDomains"`
	// If enabled, the resource will wait for the domain association status to change to `PENDING_DEPLOYMENT` or `AVAILABLE`. Setting this to `false` will skip the process. Default: `true`.
	WaitForVerification pulumi.BoolPtrOutput `pulumi:"waitForVerification"`
}

Provides an Amplify Domain Association resource.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleApp, err := amplify.NewApp(ctx, "exampleApp", &amplify.AppArgs{
			CustomRules: amplify.AppCustomRuleArray{
				&amplify.AppCustomRuleArgs{
					Source: pulumi.String("https://example.com"),
					Status: pulumi.String("302"),
					Target: pulumi.String("https://www.example.com"),
				},
			},
		})
		if err != nil {
			return err
		}
		master, err := amplify.NewBranch(ctx, "master", &amplify.BranchArgs{
			AppId:      exampleApp.ID(),
			BranchName: pulumi.String("master"),
		})
		if err != nil {
			return err
		}
		_, err = amplify.NewDomainAssociation(ctx, "exampleDomainAssociation", &amplify.DomainAssociationArgs{
			AppId:      exampleApp.ID(),
			DomainName: pulumi.String("example.com"),
			SubDomains: amplify.DomainAssociationSubDomainArray{
				&amplify.DomainAssociationSubDomainArgs{
					BranchName: master.BranchName,
					Prefix:     pulumi.String(""),
				},
				&amplify.DomainAssociationSubDomainArgs{
					BranchName: master.BranchName,
					Prefix:     pulumi.String("www"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Amplify domain association can be imported using `app_id` and `domain_name`, e.g.,

```sh

$ pulumi import aws:amplify/domainAssociation:DomainAssociation app d2ypk4k47z8u6/example.com

```

func GetDomainAssociation

func GetDomainAssociation(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *DomainAssociationState, opts ...pulumi.ResourceOption) (*DomainAssociation, error)

GetDomainAssociation gets an existing DomainAssociation 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 NewDomainAssociation

func NewDomainAssociation(ctx *pulumi.Context,
	name string, args *DomainAssociationArgs, opts ...pulumi.ResourceOption) (*DomainAssociation, error)

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

func (*DomainAssociation) ElementType

func (*DomainAssociation) ElementType() reflect.Type

func (*DomainAssociation) ToDomainAssociationOutput

func (i *DomainAssociation) ToDomainAssociationOutput() DomainAssociationOutput

func (*DomainAssociation) ToDomainAssociationOutputWithContext

func (i *DomainAssociation) ToDomainAssociationOutputWithContext(ctx context.Context) DomainAssociationOutput

func (*DomainAssociation) ToDomainAssociationPtrOutput

func (i *DomainAssociation) ToDomainAssociationPtrOutput() DomainAssociationPtrOutput

func (*DomainAssociation) ToDomainAssociationPtrOutputWithContext

func (i *DomainAssociation) ToDomainAssociationPtrOutputWithContext(ctx context.Context) DomainAssociationPtrOutput

type DomainAssociationArgs

type DomainAssociationArgs struct {
	// The unique ID for an Amplify app.
	AppId pulumi.StringInput
	// The domain name for the domain association.
	DomainName pulumi.StringInput
	// The setting for the subdomain. Documented below.
	SubDomains DomainAssociationSubDomainArrayInput
	// If enabled, the resource will wait for the domain association status to change to `PENDING_DEPLOYMENT` or `AVAILABLE`. Setting this to `false` will skip the process. Default: `true`.
	WaitForVerification pulumi.BoolPtrInput
}

The set of arguments for constructing a DomainAssociation resource.

func (DomainAssociationArgs) ElementType

func (DomainAssociationArgs) ElementType() reflect.Type

type DomainAssociationArray

type DomainAssociationArray []DomainAssociationInput

func (DomainAssociationArray) ElementType

func (DomainAssociationArray) ElementType() reflect.Type

func (DomainAssociationArray) ToDomainAssociationArrayOutput

func (i DomainAssociationArray) ToDomainAssociationArrayOutput() DomainAssociationArrayOutput

func (DomainAssociationArray) ToDomainAssociationArrayOutputWithContext

func (i DomainAssociationArray) ToDomainAssociationArrayOutputWithContext(ctx context.Context) DomainAssociationArrayOutput

type DomainAssociationArrayInput

type DomainAssociationArrayInput interface {
	pulumi.Input

	ToDomainAssociationArrayOutput() DomainAssociationArrayOutput
	ToDomainAssociationArrayOutputWithContext(context.Context) DomainAssociationArrayOutput
}

DomainAssociationArrayInput is an input type that accepts DomainAssociationArray and DomainAssociationArrayOutput values. You can construct a concrete instance of `DomainAssociationArrayInput` via:

DomainAssociationArray{ DomainAssociationArgs{...} }

type DomainAssociationArrayOutput

type DomainAssociationArrayOutput struct{ *pulumi.OutputState }

func (DomainAssociationArrayOutput) ElementType

func (DomainAssociationArrayOutput) Index

func (DomainAssociationArrayOutput) ToDomainAssociationArrayOutput

func (o DomainAssociationArrayOutput) ToDomainAssociationArrayOutput() DomainAssociationArrayOutput

func (DomainAssociationArrayOutput) ToDomainAssociationArrayOutputWithContext

func (o DomainAssociationArrayOutput) ToDomainAssociationArrayOutputWithContext(ctx context.Context) DomainAssociationArrayOutput

type DomainAssociationInput

type DomainAssociationInput interface {
	pulumi.Input

	ToDomainAssociationOutput() DomainAssociationOutput
	ToDomainAssociationOutputWithContext(ctx context.Context) DomainAssociationOutput
}

type DomainAssociationMap

type DomainAssociationMap map[string]DomainAssociationInput

func (DomainAssociationMap) ElementType

func (DomainAssociationMap) ElementType() reflect.Type

func (DomainAssociationMap) ToDomainAssociationMapOutput

func (i DomainAssociationMap) ToDomainAssociationMapOutput() DomainAssociationMapOutput

func (DomainAssociationMap) ToDomainAssociationMapOutputWithContext

func (i DomainAssociationMap) ToDomainAssociationMapOutputWithContext(ctx context.Context) DomainAssociationMapOutput

type DomainAssociationMapInput

type DomainAssociationMapInput interface {
	pulumi.Input

	ToDomainAssociationMapOutput() DomainAssociationMapOutput
	ToDomainAssociationMapOutputWithContext(context.Context) DomainAssociationMapOutput
}

DomainAssociationMapInput is an input type that accepts DomainAssociationMap and DomainAssociationMapOutput values. You can construct a concrete instance of `DomainAssociationMapInput` via:

DomainAssociationMap{ "key": DomainAssociationArgs{...} }

type DomainAssociationMapOutput

type DomainAssociationMapOutput struct{ *pulumi.OutputState }

func (DomainAssociationMapOutput) ElementType

func (DomainAssociationMapOutput) ElementType() reflect.Type

func (DomainAssociationMapOutput) MapIndex

func (DomainAssociationMapOutput) ToDomainAssociationMapOutput

func (o DomainAssociationMapOutput) ToDomainAssociationMapOutput() DomainAssociationMapOutput

func (DomainAssociationMapOutput) ToDomainAssociationMapOutputWithContext

func (o DomainAssociationMapOutput) ToDomainAssociationMapOutputWithContext(ctx context.Context) DomainAssociationMapOutput

type DomainAssociationOutput

type DomainAssociationOutput struct{ *pulumi.OutputState }

func (DomainAssociationOutput) ElementType

func (DomainAssociationOutput) ElementType() reflect.Type

func (DomainAssociationOutput) ToDomainAssociationOutput

func (o DomainAssociationOutput) ToDomainAssociationOutput() DomainAssociationOutput

func (DomainAssociationOutput) ToDomainAssociationOutputWithContext

func (o DomainAssociationOutput) ToDomainAssociationOutputWithContext(ctx context.Context) DomainAssociationOutput

func (DomainAssociationOutput) ToDomainAssociationPtrOutput

func (o DomainAssociationOutput) ToDomainAssociationPtrOutput() DomainAssociationPtrOutput

func (DomainAssociationOutput) ToDomainAssociationPtrOutputWithContext

func (o DomainAssociationOutput) ToDomainAssociationPtrOutputWithContext(ctx context.Context) DomainAssociationPtrOutput

type DomainAssociationPtrInput

type DomainAssociationPtrInput interface {
	pulumi.Input

	ToDomainAssociationPtrOutput() DomainAssociationPtrOutput
	ToDomainAssociationPtrOutputWithContext(ctx context.Context) DomainAssociationPtrOutput
}

type DomainAssociationPtrOutput

type DomainAssociationPtrOutput struct{ *pulumi.OutputState }

func (DomainAssociationPtrOutput) Elem added in v4.15.0

func (DomainAssociationPtrOutput) ElementType

func (DomainAssociationPtrOutput) ElementType() reflect.Type

func (DomainAssociationPtrOutput) ToDomainAssociationPtrOutput

func (o DomainAssociationPtrOutput) ToDomainAssociationPtrOutput() DomainAssociationPtrOutput

func (DomainAssociationPtrOutput) ToDomainAssociationPtrOutputWithContext

func (o DomainAssociationPtrOutput) ToDomainAssociationPtrOutputWithContext(ctx context.Context) DomainAssociationPtrOutput

type DomainAssociationState

type DomainAssociationState struct {
	// The unique ID for an Amplify app.
	AppId pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) for the domain association.
	Arn pulumi.StringPtrInput
	// The DNS record for certificate verification.
	CertificateVerificationDnsRecord pulumi.StringPtrInput
	// The domain name for the domain association.
	DomainName pulumi.StringPtrInput
	// The setting for the subdomain. Documented below.
	SubDomains DomainAssociationSubDomainArrayInput
	// If enabled, the resource will wait for the domain association status to change to `PENDING_DEPLOYMENT` or `AVAILABLE`. Setting this to `false` will skip the process. Default: `true`.
	WaitForVerification pulumi.BoolPtrInput
}

func (DomainAssociationState) ElementType

func (DomainAssociationState) ElementType() reflect.Type

type DomainAssociationSubDomain

type DomainAssociationSubDomain struct {
	// The branch name setting for the subdomain.
	BranchName string `pulumi:"branchName"`
	// The DNS record for the subdomain.
	DnsRecord *string `pulumi:"dnsRecord"`
	// The prefix setting for the subdomain.
	Prefix string `pulumi:"prefix"`
	// The verified status of the subdomain.
	Verified *bool `pulumi:"verified"`
}

type DomainAssociationSubDomainArgs

type DomainAssociationSubDomainArgs struct {
	// The branch name setting for the subdomain.
	BranchName pulumi.StringInput `pulumi:"branchName"`
	// The DNS record for the subdomain.
	DnsRecord pulumi.StringPtrInput `pulumi:"dnsRecord"`
	// The prefix setting for the subdomain.
	Prefix pulumi.StringInput `pulumi:"prefix"`
	// The verified status of the subdomain.
	Verified pulumi.BoolPtrInput `pulumi:"verified"`
}

func (DomainAssociationSubDomainArgs) ElementType

func (DomainAssociationSubDomainArgs) ToDomainAssociationSubDomainOutput

func (i DomainAssociationSubDomainArgs) ToDomainAssociationSubDomainOutput() DomainAssociationSubDomainOutput

func (DomainAssociationSubDomainArgs) ToDomainAssociationSubDomainOutputWithContext

func (i DomainAssociationSubDomainArgs) ToDomainAssociationSubDomainOutputWithContext(ctx context.Context) DomainAssociationSubDomainOutput

type DomainAssociationSubDomainArray

type DomainAssociationSubDomainArray []DomainAssociationSubDomainInput

func (DomainAssociationSubDomainArray) ElementType

func (DomainAssociationSubDomainArray) ToDomainAssociationSubDomainArrayOutput

func (i DomainAssociationSubDomainArray) ToDomainAssociationSubDomainArrayOutput() DomainAssociationSubDomainArrayOutput

func (DomainAssociationSubDomainArray) ToDomainAssociationSubDomainArrayOutputWithContext

func (i DomainAssociationSubDomainArray) ToDomainAssociationSubDomainArrayOutputWithContext(ctx context.Context) DomainAssociationSubDomainArrayOutput

type DomainAssociationSubDomainArrayInput

type DomainAssociationSubDomainArrayInput interface {
	pulumi.Input

	ToDomainAssociationSubDomainArrayOutput() DomainAssociationSubDomainArrayOutput
	ToDomainAssociationSubDomainArrayOutputWithContext(context.Context) DomainAssociationSubDomainArrayOutput
}

DomainAssociationSubDomainArrayInput is an input type that accepts DomainAssociationSubDomainArray and DomainAssociationSubDomainArrayOutput values. You can construct a concrete instance of `DomainAssociationSubDomainArrayInput` via:

DomainAssociationSubDomainArray{ DomainAssociationSubDomainArgs{...} }

type DomainAssociationSubDomainArrayOutput

type DomainAssociationSubDomainArrayOutput struct{ *pulumi.OutputState }

func (DomainAssociationSubDomainArrayOutput) ElementType

func (DomainAssociationSubDomainArrayOutput) Index

func (DomainAssociationSubDomainArrayOutput) ToDomainAssociationSubDomainArrayOutput

func (o DomainAssociationSubDomainArrayOutput) ToDomainAssociationSubDomainArrayOutput() DomainAssociationSubDomainArrayOutput

func (DomainAssociationSubDomainArrayOutput) ToDomainAssociationSubDomainArrayOutputWithContext

func (o DomainAssociationSubDomainArrayOutput) ToDomainAssociationSubDomainArrayOutputWithContext(ctx context.Context) DomainAssociationSubDomainArrayOutput

type DomainAssociationSubDomainInput

type DomainAssociationSubDomainInput interface {
	pulumi.Input

	ToDomainAssociationSubDomainOutput() DomainAssociationSubDomainOutput
	ToDomainAssociationSubDomainOutputWithContext(context.Context) DomainAssociationSubDomainOutput
}

DomainAssociationSubDomainInput is an input type that accepts DomainAssociationSubDomainArgs and DomainAssociationSubDomainOutput values. You can construct a concrete instance of `DomainAssociationSubDomainInput` via:

DomainAssociationSubDomainArgs{...}

type DomainAssociationSubDomainOutput

type DomainAssociationSubDomainOutput struct{ *pulumi.OutputState }

func (DomainAssociationSubDomainOutput) BranchName

The branch name setting for the subdomain.

func (DomainAssociationSubDomainOutput) DnsRecord

The DNS record for the subdomain.

func (DomainAssociationSubDomainOutput) ElementType

func (DomainAssociationSubDomainOutput) Prefix

The prefix setting for the subdomain.

func (DomainAssociationSubDomainOutput) ToDomainAssociationSubDomainOutput

func (o DomainAssociationSubDomainOutput) ToDomainAssociationSubDomainOutput() DomainAssociationSubDomainOutput

func (DomainAssociationSubDomainOutput) ToDomainAssociationSubDomainOutputWithContext

func (o DomainAssociationSubDomainOutput) ToDomainAssociationSubDomainOutputWithContext(ctx context.Context) DomainAssociationSubDomainOutput

func (DomainAssociationSubDomainOutput) Verified

The verified status of the subdomain.

type Webhook

type Webhook struct {
	pulumi.CustomResourceState

	// The unique ID for an Amplify app.
	AppId pulumi.StringOutput `pulumi:"appId"`
	// The Amazon Resource Name (ARN) for the webhook.
	Arn pulumi.StringOutput `pulumi:"arn"`
	// The name for a branch that is part of the Amplify app.
	BranchName pulumi.StringOutput `pulumi:"branchName"`
	// The description for a webhook.
	Description pulumi.StringPtrOutput `pulumi:"description"`
	// The URL of the webhook.
	Url pulumi.StringOutput `pulumi:"url"`
}

Provides an Amplify Webhook resource.

## Example Usage

```go package main

import (

"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/amplify"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"

)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := amplify.NewApp(ctx, "example", nil)
		if err != nil {
			return err
		}
		masterBranch, err := amplify.NewBranch(ctx, "masterBranch", &amplify.BranchArgs{
			AppId:      example.ID(),
			BranchName: pulumi.String("master"),
		})
		if err != nil {
			return err
		}
		_, err = amplify.NewWebhook(ctx, "masterWebhook", &amplify.WebhookArgs{
			AppId:       example.ID(),
			BranchName:  masterBranch.BranchName,
			Description: pulumi.String("triggermaster"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

```

## Import

Amplify webhook can be imported using a webhook ID, e.g.,

```sh

$ pulumi import aws:amplify/webhook:Webhook master a26b22a0-748b-4b57-b9a0-ae7e601fe4b1

```

func GetWebhook

func GetWebhook(ctx *pulumi.Context,
	name string, id pulumi.IDInput, state *WebhookState, opts ...pulumi.ResourceOption) (*Webhook, error)

GetWebhook gets an existing Webhook 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 NewWebhook

func NewWebhook(ctx *pulumi.Context,
	name string, args *WebhookArgs, opts ...pulumi.ResourceOption) (*Webhook, error)

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

func (*Webhook) ElementType

func (*Webhook) ElementType() reflect.Type

func (*Webhook) ToWebhookOutput

func (i *Webhook) ToWebhookOutput() WebhookOutput

func (*Webhook) ToWebhookOutputWithContext

func (i *Webhook) ToWebhookOutputWithContext(ctx context.Context) WebhookOutput

func (*Webhook) ToWebhookPtrOutput

func (i *Webhook) ToWebhookPtrOutput() WebhookPtrOutput

func (*Webhook) ToWebhookPtrOutputWithContext

func (i *Webhook) ToWebhookPtrOutputWithContext(ctx context.Context) WebhookPtrOutput

type WebhookArgs

type WebhookArgs struct {
	// The unique ID for an Amplify app.
	AppId pulumi.StringInput
	// The name for a branch that is part of the Amplify app.
	BranchName pulumi.StringInput
	// The description for a webhook.
	Description pulumi.StringPtrInput
}

The set of arguments for constructing a Webhook resource.

func (WebhookArgs) ElementType

func (WebhookArgs) ElementType() reflect.Type

type WebhookArray

type WebhookArray []WebhookInput

func (WebhookArray) ElementType

func (WebhookArray) ElementType() reflect.Type

func (WebhookArray) ToWebhookArrayOutput

func (i WebhookArray) ToWebhookArrayOutput() WebhookArrayOutput

func (WebhookArray) ToWebhookArrayOutputWithContext

func (i WebhookArray) ToWebhookArrayOutputWithContext(ctx context.Context) WebhookArrayOutput

type WebhookArrayInput

type WebhookArrayInput interface {
	pulumi.Input

	ToWebhookArrayOutput() WebhookArrayOutput
	ToWebhookArrayOutputWithContext(context.Context) WebhookArrayOutput
}

WebhookArrayInput is an input type that accepts WebhookArray and WebhookArrayOutput values. You can construct a concrete instance of `WebhookArrayInput` via:

WebhookArray{ WebhookArgs{...} }

type WebhookArrayOutput

type WebhookArrayOutput struct{ *pulumi.OutputState }

func (WebhookArrayOutput) ElementType

func (WebhookArrayOutput) ElementType() reflect.Type

func (WebhookArrayOutput) Index

func (WebhookArrayOutput) ToWebhookArrayOutput

func (o WebhookArrayOutput) ToWebhookArrayOutput() WebhookArrayOutput

func (WebhookArrayOutput) ToWebhookArrayOutputWithContext

func (o WebhookArrayOutput) ToWebhookArrayOutputWithContext(ctx context.Context) WebhookArrayOutput

type WebhookInput

type WebhookInput interface {
	pulumi.Input

	ToWebhookOutput() WebhookOutput
	ToWebhookOutputWithContext(ctx context.Context) WebhookOutput
}

type WebhookMap

type WebhookMap map[string]WebhookInput

func (WebhookMap) ElementType

func (WebhookMap) ElementType() reflect.Type

func (WebhookMap) ToWebhookMapOutput

func (i WebhookMap) ToWebhookMapOutput() WebhookMapOutput

func (WebhookMap) ToWebhookMapOutputWithContext

func (i WebhookMap) ToWebhookMapOutputWithContext(ctx context.Context) WebhookMapOutput

type WebhookMapInput

type WebhookMapInput interface {
	pulumi.Input

	ToWebhookMapOutput() WebhookMapOutput
	ToWebhookMapOutputWithContext(context.Context) WebhookMapOutput
}

WebhookMapInput is an input type that accepts WebhookMap and WebhookMapOutput values. You can construct a concrete instance of `WebhookMapInput` via:

WebhookMap{ "key": WebhookArgs{...} }

type WebhookMapOutput

type WebhookMapOutput struct{ *pulumi.OutputState }

func (WebhookMapOutput) ElementType

func (WebhookMapOutput) ElementType() reflect.Type

func (WebhookMapOutput) MapIndex

func (WebhookMapOutput) ToWebhookMapOutput

func (o WebhookMapOutput) ToWebhookMapOutput() WebhookMapOutput

func (WebhookMapOutput) ToWebhookMapOutputWithContext

func (o WebhookMapOutput) ToWebhookMapOutputWithContext(ctx context.Context) WebhookMapOutput

type WebhookOutput

type WebhookOutput struct{ *pulumi.OutputState }

func (WebhookOutput) ElementType

func (WebhookOutput) ElementType() reflect.Type

func (WebhookOutput) ToWebhookOutput

func (o WebhookOutput) ToWebhookOutput() WebhookOutput

func (WebhookOutput) ToWebhookOutputWithContext

func (o WebhookOutput) ToWebhookOutputWithContext(ctx context.Context) WebhookOutput

func (WebhookOutput) ToWebhookPtrOutput

func (o WebhookOutput) ToWebhookPtrOutput() WebhookPtrOutput

func (WebhookOutput) ToWebhookPtrOutputWithContext

func (o WebhookOutput) ToWebhookPtrOutputWithContext(ctx context.Context) WebhookPtrOutput

type WebhookPtrInput

type WebhookPtrInput interface {
	pulumi.Input

	ToWebhookPtrOutput() WebhookPtrOutput
	ToWebhookPtrOutputWithContext(ctx context.Context) WebhookPtrOutput
}

type WebhookPtrOutput

type WebhookPtrOutput struct{ *pulumi.OutputState }

func (WebhookPtrOutput) Elem added in v4.15.0

func (WebhookPtrOutput) ElementType

func (WebhookPtrOutput) ElementType() reflect.Type

func (WebhookPtrOutput) ToWebhookPtrOutput

func (o WebhookPtrOutput) ToWebhookPtrOutput() WebhookPtrOutput

func (WebhookPtrOutput) ToWebhookPtrOutputWithContext

func (o WebhookPtrOutput) ToWebhookPtrOutputWithContext(ctx context.Context) WebhookPtrOutput

type WebhookState

type WebhookState struct {
	// The unique ID for an Amplify app.
	AppId pulumi.StringPtrInput
	// The Amazon Resource Name (ARN) for the webhook.
	Arn pulumi.StringPtrInput
	// The name for a branch that is part of the Amplify app.
	BranchName pulumi.StringPtrInput
	// The description for a webhook.
	Description pulumi.StringPtrInput
	// The URL of the webhook.
	Url pulumi.StringPtrInput
}

func (WebhookState) ElementType

func (WebhookState) ElementType() reflect.Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL