aws_amplify_branch

Documentation

Index

• type Args
• type Resource
  • func New(name string, args Args) *Resource
  • func (aab *Resource) Attributes() awsAmplifyBranchAttributes
  • func (aab *Resource) Configuration() interface{}
  • func (aab *Resource) DependOn() terra.Reference
  • func (aab *Resource) Dependencies() terra.Dependencies
  • func (aab *Resource) ImportState(state io.Reader) error
  • func (aab *Resource) LifecycleManagement() *terra.Lifecycle
  • func (aab *Resource) LocalName() string
  • func (aab *Resource) State() (*awsAmplifyBranchState, bool)
  • func (aab *Resource) StateMust() *awsAmplifyBranchState
  • func (aab *Resource) Type() string

Types

type Args

type Args struct {
	// AppId: string, required
	AppId terra.StringValue `hcl:"app_id,attr" validate:"required"`
	// BackendEnvironmentArn: string, optional
	BackendEnvironmentArn terra.StringValue `hcl:"backend_environment_arn,attr"`
	// BasicAuthCredentials: string, optional
	BasicAuthCredentials terra.StringValue `hcl:"basic_auth_credentials,attr"`
	// BranchName: string, required
	BranchName terra.StringValue `hcl:"branch_name,attr" validate:"required"`
	// Description: string, optional
	Description terra.StringValue `hcl:"description,attr"`
	// DisplayName: string, optional
	DisplayName terra.StringValue `hcl:"display_name,attr"`
	// EnableAutoBuild: bool, optional
	EnableAutoBuild terra.BoolValue `hcl:"enable_auto_build,attr"`
	// EnableBasicAuth: bool, optional
	EnableBasicAuth terra.BoolValue `hcl:"enable_basic_auth,attr"`
	// EnableNotification: bool, optional
	EnableNotification terra.BoolValue `hcl:"enable_notification,attr"`
	// EnablePerformanceMode: bool, optional
	EnablePerformanceMode terra.BoolValue `hcl:"enable_performance_mode,attr"`
	// EnablePullRequestPreview: bool, optional
	EnablePullRequestPreview terra.BoolValue `hcl:"enable_pull_request_preview,attr"`
	// EnvironmentVariables: map of string, optional
	EnvironmentVariables terra.MapValue[terra.StringValue] `hcl:"environment_variables,attr"`
	// Framework: string, optional
	Framework terra.StringValue `hcl:"framework,attr"`
	// Id: string, optional
	Id terra.StringValue `hcl:"id,attr"`
	// PullRequestEnvironmentName: string, optional
	PullRequestEnvironmentName terra.StringValue `hcl:"pull_request_environment_name,attr"`
	// Stage: string, optional
	Stage terra.StringValue `hcl:"stage,attr"`
	// Tags: map of string, optional
	Tags terra.MapValue[terra.StringValue] `hcl:"tags,attr"`
	// TagsAll: map of string, optional
	TagsAll terra.MapValue[terra.StringValue] `hcl:"tags_all,attr"`
	// Ttl: string, optional
	Ttl terra.StringValue `hcl:"ttl,attr"`
}

Args contains the configurations for aws_amplify_branch.

type Resource

type Resource struct {
	Name string
	Args Args

	DependsOn terra.Dependencies
	Lifecycle *terra.Lifecycle
	// contains filtered or unexported fields
}

Resource represents the Terraform resource aws_amplify_branch.

func New

func New(name string, args Args) *Resource

New creates a new instance of Resource.

func (*Resource) Attributes

func (aab *Resource) Attributes() awsAmplifyBranchAttributes

Attributes returns the attributes for Resource.

func (*Resource) Configuration

func (aab *Resource) Configuration() interface{}

Configuration returns the configuration (args) for Resource.

func (*Resource) DependOn

func (aab *Resource) DependOn() terra.Reference

DependOn is used for other resources to depend on Resource.

func (*Resource) Dependencies

func (aab *Resource) Dependencies() terra.Dependencies

Dependencies returns the list of resources Resource depends_on.

func (*Resource) ImportState

func (aab *Resource) ImportState(state io.Reader) error

ImportState imports the given attribute values into Resource's state.

func (*Resource) LifecycleManagement

func (aab *Resource) LifecycleManagement() *terra.Lifecycle

LifecycleManagement returns the lifecycle block for Resource.

func (*Resource) LocalName

func (aab *Resource) LocalName() string

LocalName returns the local name for Resource.

func (*Resource) State

func (aab *Resource) State() (*awsAmplifyBranchState, bool)

State returns the state and a bool indicating if Resource has state.

func (*Resource) StateMust

func (aab *Resource) StateMust() *awsAmplifyBranchState

StateMust returns the state for Resource. Panics if the state is nil.

func (*Resource) Type

func (aab *Resource) Type() string

Type returns the Terraform object type for Resource.