Package io.github.cdklabs.projen.release

Interface CodeArtifactOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CodeArtifactOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.248Z")
@Stability(Experimental)
public interface CodeArtifactOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Options for publishing packages to AWS CodeArtifact.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CodeArtifactOptions.Builder	A builder for CodeArtifactOptions
static class	CodeArtifactOptions.Jsii$Proxy	An implementation for CodeArtifactOptions

Method Summary

Modifier and Type	Method	Description
static CodeArtifactOptions.Builder	builder()
default String	getAccessKeyIdSecret()	(experimental) GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.
default CodeArtifactAuthProvider	getAuthProvider()	(experimental) Provider to use for authorizing requests to AWS CodeArtifact.
default String	getRoleToAssume()	(experimental) ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (registry contains AWS CodeArtifact URL).
default String	getSecretAccessKeySecret()	(experimental) GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAccessKeyIdSecret

@Stability(Experimental)
@Nullable
default String getAccessKeyIdSecret()

(experimental) GitHub secret which contains the AWS access key ID to use when publishing packages to AWS CodeArtifact.

This property must be specified only when publishing to AWS CodeArtifact (npmRegistryUrl contains AWS CodeArtifact URL).

Default: - When the `authProvider` value is set to `CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR`, the default is "AWS_ACCESS_KEY_ID". For `CodeArtifactAuthProvider.GITHUB_OIDC`, this value must be left undefined.

getAuthProvider

@Stability(Experimental)
@Nullable
default CodeArtifactAuthProvider getAuthProvider()

(experimental) Provider to use for authorizing requests to AWS CodeArtifact.

Default: CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR

getRoleToAssume

@Stability(Experimental)
@Nullable
default String getRoleToAssume()

(experimental) ARN of AWS role to be assumed prior to get authorization token from AWS CodeArtifact This property must be specified only when publishing to AWS CodeArtifact (registry contains AWS CodeArtifact URL).

When using the CodeArtifactAuthProvider.GITHUB_OIDC auth provider, this value must be defined.

Default: undefined

getSecretAccessKeySecret

@Stability(Experimental)
@Nullable
default String getSecretAccessKeySecret()

(experimental) GitHub secret which contains the AWS secret access key to use when publishing packages to AWS CodeArtifact.

This property must be specified only when publishing to AWS CodeArtifact (npmRegistryUrl contains AWS CodeArtifact URL).

Default: - When the `authProvider` value is set to `CodeArtifactAuthProvider.ACCESS_AND_SECRET_KEY_PAIR`, the default is "AWS_SECRET_ACCESS_KEY". For `CodeArtifactAuthProvider.GITHUB_OIDC`, this value must be left undefined.

builder

@Stability(Experimental)
static CodeArtifactOptions.Builder builder()

Returns:

a CodeArtifactOptions.Builder of CodeArtifactOptions