Class: Aws::CodeArtifact::Types::PutPackageOriginConfigurationRequest

Inherits:

Struct

• Object
• Struct
• Aws::CodeArtifact::Types::PutPackageOriginConfigurationRequest

Includes:

Structure

Defined in:

lib/aws-sdk-codeartifact/types.rb

Overview

Note:

When making an API call, you may pass PutPackageOriginConfigurationRequest data as a hash:

{
  domain: "DomainName", # required
  domain_owner: "AccountId",
  repository: "RepositoryName", # required
  format: "npm", # required, accepts npm, pypi, maven, nuget
  namespace: "PackageNamespace",
  package: "PackageName", # required
  restrictions: { # required
    publish: "ALLOW", # required, accepts ALLOW, BLOCK
    upstream: "ALLOW", # required, accepts ALLOW, BLOCK
  },
}

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #domain ⇒ String

  The name of the domain that contains the repository that contains the package.

• #domain_owner ⇒ String

  The 12-digit account number of the Amazon Web Services account that owns the domain.

• #format ⇒ String

  A format that specifies the type of the package to be updated.

• #namespace ⇒ String

  The namespace of the package to be updated.

• #package ⇒ String

  The name of the package to be updated.

• #repository ⇒ String

  The name of the repository that contains the package.

• #restrictions ⇒ Types::PackageOriginRestrictions

  A [PackageOriginRestrictions] object that contains information about the `upstream` and `publish` package origin restrictions.

Instance Attribute Details

#domain ⇒ String

The name of the domain that contains the repository that contains the package.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2994

class PutPackageOriginConfigurationRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :restrictions)
  SENSITIVE = []
  include Aws::Structure
end

#domain_owner ⇒ String

The 12-digit account number of the Amazon Web Services account that owns the domain. It does not include dashes or spaces.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2994

class PutPackageOriginConfigurationRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :restrictions)
  SENSITIVE = []
  include Aws::Structure
end

#format ⇒ String

A format that specifies the type of the package to be updated.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2994

class PutPackageOriginConfigurationRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :restrictions)
  SENSITIVE = []
  include Aws::Structure
end

#namespace ⇒ String

The namespace of the package to be updated. The package component that specifies its namespace depends on its type. For example:

• The namespace of a Maven package is its `groupId`.

• The namespace of an npm package is its `scope`.

• Python and NuGet packages do not contain a corresponding component, packages of those formats do not have a namespace.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2994

class PutPackageOriginConfigurationRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :restrictions)
  SENSITIVE = []
  include Aws::Structure
end

#package ⇒ String

The name of the package to be updated.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2994

class PutPackageOriginConfigurationRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :restrictions)
  SENSITIVE = []
  include Aws::Structure
end

#repository ⇒ String

The name of the repository that contains the package.

Returns:

• (String)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2994

class PutPackageOriginConfigurationRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :restrictions)
  SENSITIVE = []
  include Aws::Structure
end

#restrictions ⇒ Types::PackageOriginRestrictions

A [PackageOriginRestrictions] object that contains information about the `upstream` and `publish` package origin restrictions. The `upstream` restriction determines if new package versions can be ingested or retained from external connections or upstream repositories. The `publish` restriction determines if new package versions can be published directly to the repository.

You must include both the desired `upstream` and `publish` restrictions.

[1]: docs.aws.amazon.com/codeartifact/latest/APIReference/API_PackageOriginRestrictions.html

Returns:

• (Types::PackageOriginRestrictions)

# File 'lib/aws-sdk-codeartifact/types.rb', line 2994

class PutPackageOriginConfigurationRequest < Struct.new(
  :domain,
  :domain_owner,
  :repository,
  :format,
  :namespace,
  :package,
  :restrictions)
  SENSITIVE = []
  include Aws::Structure
end