awscodeartifact

Documentation

Index

• func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string
• func CfnDomain_IsCfnElement(x interface{}) *bool
• func CfnDomain_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnDomain_IsConstruct(x interface{}) *bool
• func CfnRepository_CFN_RESOURCE_TYPE_NAME() *string
• func CfnRepository_IsCfnElement(x interface{}) *bool
• func CfnRepository_IsCfnResource(construct constructs.IConstruct) *bool
• func CfnRepository_IsConstruct(x interface{}) *bool
• func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)
• func NewCfnRepository_Override(c CfnRepository, scope constructs.Construct, id *string, ...)
• type CfnDomain
  • func NewCfnDomain(scope constructs.Construct, id *string, props *CfnDomainProps) CfnDomain
• type CfnDomainProps
• type CfnRepository
  • func NewCfnRepository(scope constructs.Construct, id *string, props *CfnRepositoryProps) CfnRepository
• type CfnRepositoryProps

Functions

func CfnDomain_CFN_RESOURCE_TYPE_NAME

func CfnDomain_CFN_RESOURCE_TYPE_NAME() *string

func CfnDomain_IsCfnElement

func CfnDomain_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnDomain_IsCfnResource

func CfnDomain_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnDomain_IsConstruct

func CfnDomain_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func CfnRepository_CFN_RESOURCE_TYPE_NAME

func CfnRepository_CFN_RESOURCE_TYPE_NAME() *string

func CfnRepository_IsCfnElement

func CfnRepository_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnRepository_IsCfnResource

func CfnRepository_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnRepository_IsConstruct

func CfnRepository_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Returns: true if `x` is an object created from a class which extends `Construct`. Deprecated: use `x instanceof Construct` instead

func NewCfnDomain_Override

func NewCfnDomain_Override(c CfnDomain, scope constructs.Construct, id *string, props *CfnDomainProps)

Create a new `AWS::CodeArtifact::Domain`.

func NewCfnRepository_Override

func NewCfnRepository_Override(c CfnRepository, scope constructs.Construct, id *string, props *CfnRepositoryProps)

Create a new `AWS::CodeArtifact::Repository`.

Types

type CfnDomain

type CfnDomain interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrEncryptionKey() *string
	AttrName() *string
	AttrOwner() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	DomainName() *string
	SetDomainName(val *string)
	EncryptionKey() *string
	SetEncryptionKey(val *string)
	LogicalId() *string
	Node() constructs.Node
	PermissionsPolicyDocument() interface{}
	SetPermissionsPolicyDocument(val interface{})
	Ref() *string
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CodeArtifact::Domain`.

The `AWS::CodeArtifact::Domain` resource creates an AWS CodeArtifact domain. CodeArtifact *domains* make it easier to manage multiple repositories across an organization. You can use a domain to apply permissions across many repositories owned by different AWS accounts. For more information about domains, see the [Domain concepts information](https://docs.aws.amazon.com/codeartifact/latest/ug/codeartifact-concepts.html#welcome-concepts-domain) in the *CodeArtifact User Guide* . For more information about the `CreateDomain` API, see [CreateDomain](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateDomain.html) in the *CodeArtifact API Reference* .

TODO: EXAMPLE

func NewCfnDomain

func NewCfnDomain(scope constructs.Construct, id *string, props *CfnDomainProps) CfnDomain

Create a new `AWS::CodeArtifact::Domain`.

type CfnDomainProps

type CfnDomainProps struct {
	// A string that specifies the name of the requested domain.
	DomainName *string `json:"domainName" yaml:"domainName"`
	// The key used to encrypt the domain.
	EncryptionKey *string `json:"encryptionKey" yaml:"encryptionKey"`
	// The document that defines the resource policy that is set on a domain.
	PermissionsPolicyDocument interface{} `json:"permissionsPolicyDocument" yaml:"permissionsPolicyDocument"`
	// A list of tags to be applied to the domain.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
}

Properties for defining a `CfnDomain`.

TODO: EXAMPLE

type CfnRepository

type CfnRepository interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrDomainName() *string
	AttrDomainOwner() *string
	AttrName() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	DomainName() *string
	SetDomainName(val *string)
	DomainOwner() *string
	SetDomainOwner(val *string)
	ExternalConnections() *[]*string
	SetExternalConnections(val *[]*string)
	LogicalId() *string
	Node() constructs.Node
	PermissionsPolicyDocument() interface{}
	SetPermissionsPolicyDocument(val interface{})
	Ref() *string
	RepositoryName() *string
	SetRepositoryName(val *string)
	Stack() awscdk.Stack
	Tags() awscdk.TagManager
	UpdatedProperites() *map[string]interface{}
	Upstreams() *[]*string
	SetUpstreams(val *[]*string)
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::CodeArtifact::Repository`.

The `AWS::CodeArtifact::Repository` resource creates an AWS CodeArtifact repository. CodeArtifact *repositories* contain a set of package versions. For more information about repositories, see the [Repository concepts information](https://docs.aws.amazon.com/codeartifact/latest/ug/codeartifact-concepts.html#welcome-concepts-repository) in the *CodeArtifact User Guide* . For more information about the `CreateRepository` API, see [CreateRepository](https://docs.aws.amazon.com/codeartifact/latest/APIReference/API_CreateRepository.html) in the *CodeArtifact API Reference* .

TODO: EXAMPLE

func NewCfnRepository

func NewCfnRepository(scope constructs.Construct, id *string, props *CfnRepositoryProps) CfnRepository

Create a new `AWS::CodeArtifact::Repository`.

type CfnRepositoryProps

type CfnRepositoryProps struct {
	// The name of the domain that contains the repository.
	DomainName *string `json:"domainName" yaml:"domainName"`
	// The name of an upstream repository.
	RepositoryName *string `json:"repositoryName" yaml:"repositoryName"`
	// A text description of the repository.
	Description *string `json:"description" yaml:"description"`
	// The 12-digit account number of the AWS account that owns the domain that contains the repository.
	//
	// It does not include dashes or spaces.
	DomainOwner *string `json:"domainOwner" yaml:"domainOwner"`
	// An array of external connections associated with the repository.
	ExternalConnections *[]*string `json:"externalConnections" yaml:"externalConnections"`
	// The document that defines the resource policy that is set on a repository.
	PermissionsPolicyDocument interface{} `json:"permissionsPolicyDocument" yaml:"permissionsPolicyDocument"`
	// A list of tags to be applied to the repository.
	Tags *[]*awscdk.CfnTag `json:"tags" yaml:"tags"`
	// A list of upstream repositories to associate with the repository.
	//
	// The order of the upstream repositories in the list determines their priority order when AWS CodeArtifact looks for a requested package version. For more information, see [Working with upstream repositories](https://docs.aws.amazon.com/codeartifact/latest/ug/repos-upstream.html) .
	Upstreams *[]*string `json:"upstreams" yaml:"upstreams"`
}

Properties for defining a `CfnRepository`.

TODO: EXAMPLE