Documentation
¶
Index ¶
- func CfnProfilePermission_CFN_RESOURCE_TYPE_NAME() *string
- func CfnProfilePermission_IsCfnElement(x interface{}) *bool
- func CfnProfilePermission_IsCfnProfilePermission(x interface{}) *bool
- func CfnProfilePermission_IsCfnResource(x interface{}) *bool
- func CfnProfilePermission_IsConstruct(x interface{}) *bool
- func CfnSigningJob_ArnForSigningJob(resource interfacesawssigner.ISigningJobRef) *string
- func CfnSigningJob_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSigningJob_IsCfnElement(x interface{}) *bool
- func CfnSigningJob_IsCfnResource(x interface{}) *bool
- func CfnSigningJob_IsCfnSigningJob(x interface{}) *bool
- func CfnSigningJob_IsConstruct(x interface{}) *bool
- func CfnSigningProfile_ArnForSigningProfile(resource interfacesawssigner.ISigningProfileRef) *string
- func CfnSigningProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnSigningProfile_IsCfnElement(x interface{}) *bool
- func CfnSigningProfile_IsCfnResource(x interface{}) *bool
- func CfnSigningProfile_IsCfnSigningProfile(x interface{}) *bool
- func CfnSigningProfile_IsConstruct(x interface{}) *bool
- func NewCfnProfilePermission_Override(c CfnProfilePermission, scope constructs.Construct, id *string, ...)
- func NewCfnSigningJob_Override(c CfnSigningJob, scope constructs.Construct, id *string, ...)
- func NewCfnSigningProfile_Override(c CfnSigningProfile, scope constructs.Construct, id *string, ...)
- func NewSigningProfile_Override(s SigningProfile, scope constructs.Construct, id *string, ...)
- func SigningProfile_IsConstruct(x interface{}) *bool
- func SigningProfile_IsOwnedResource(construct constructs.IConstruct) *bool
- func SigningProfile_IsResource(construct constructs.IConstruct) *bool
- func SigningProfile_PROPERTY_INJECTION_ID() *string
- type CfnProfilePermission
- type CfnProfilePermissionProps
- type CfnSigningJob
- type CfnSigningJobProps
- type CfnSigningJob_S3SignedObjectProperty
- type CfnSigningJob_S3SourceProperty
- type CfnSigningJob_SignedObjectProperty
- type CfnSigningJob_SourceProperty
- type CfnSigningProfile
- type CfnSigningProfileProps
- type CfnSigningProfile_SignatureValidityPeriodProperty
- type ISigningProfile
- type Platform
- func Platform_AMAZON_FREE_RTOS_DEFAULT() Platform
- func Platform_AMAZON_FREE_RTOS_TI_CC3220SF() Platform
- func Platform_AWS_IOT_DEVICE_MANAGEMENT_SHA256_ECDSA() Platform
- func Platform_AWS_LAMBDA_SHA384_ECDSA() Platform
- func Platform_NOTATION_OCI_SHA384_ECDSA() Platform
- func Platform_Of(platformId *string) Platform
- type SigningProfile
- type SigningProfileAttributes
- type SigningProfileProps
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnProfilePermission_CFN_RESOURCE_TYPE_NAME ¶
func CfnProfilePermission_CFN_RESOURCE_TYPE_NAME() *string
func CfnProfilePermission_IsCfnElement ¶
func CfnProfilePermission_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 CfnProfilePermission_IsCfnProfilePermission ¶ added in v2.231.0
func CfnProfilePermission_IsCfnProfilePermission(x interface{}) *bool
Checks whether the given object is a CfnProfilePermission.
func CfnProfilePermission_IsCfnResource ¶
func CfnProfilePermission_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnProfilePermission_IsConstruct ¶
func CfnProfilePermission_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSigningJob_ArnForSigningJob ¶ added in v2.264.0
func CfnSigningJob_ArnForSigningJob(resource interfacesawssigner.ISigningJobRef) *string
func CfnSigningJob_CFN_RESOURCE_TYPE_NAME ¶ added in v2.264.0
func CfnSigningJob_CFN_RESOURCE_TYPE_NAME() *string
func CfnSigningJob_IsCfnElement ¶ added in v2.264.0
func CfnSigningJob_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 CfnSigningJob_IsCfnResource ¶ added in v2.264.0
func CfnSigningJob_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSigningJob_IsCfnSigningJob ¶ added in v2.264.0
func CfnSigningJob_IsCfnSigningJob(x interface{}) *bool
Checks whether the given object is a CfnSigningJob.
func CfnSigningJob_IsConstruct ¶ added in v2.264.0
func CfnSigningJob_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnSigningProfile_ArnForSigningProfile ¶ added in v2.227.0
func CfnSigningProfile_ArnForSigningProfile(resource interfacesawssigner.ISigningProfileRef) *string
func CfnSigningProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnSigningProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnSigningProfile_IsCfnElement ¶
func CfnSigningProfile_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 CfnSigningProfile_IsCfnResource ¶
func CfnSigningProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnSigningProfile_IsCfnSigningProfile ¶ added in v2.231.0
func CfnSigningProfile_IsCfnSigningProfile(x interface{}) *bool
Checks whether the given object is a CfnSigningProfile.
func CfnSigningProfile_IsConstruct ¶
func CfnSigningProfile_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnProfilePermission_Override ¶
func NewCfnProfilePermission_Override(c CfnProfilePermission, scope constructs.Construct, id *string, props *CfnProfilePermissionProps)
Create a new `AWS::Signer::ProfilePermission`.
func NewCfnSigningJob_Override ¶ added in v2.264.0
func NewCfnSigningJob_Override(c CfnSigningJob, scope constructs.Construct, id *string, props *CfnSigningJobProps)
Create a new `AWS::Signer::SigningJob`.
func NewCfnSigningProfile_Override ¶
func NewCfnSigningProfile_Override(c CfnSigningProfile, scope constructs.Construct, id *string, props *CfnSigningProfileProps)
Create a new `AWS::Signer::SigningProfile`.
func NewSigningProfile_Override ¶
func NewSigningProfile_Override(s SigningProfile, scope constructs.Construct, id *string, props *SigningProfileProps)
func SigningProfile_IsConstruct ¶
func SigningProfile_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func SigningProfile_IsOwnedResource ¶ added in v2.32.0
func SigningProfile_IsOwnedResource(construct constructs.IConstruct) *bool
Returns true if the construct was created by CDK, and false otherwise.
func SigningProfile_IsResource ¶
func SigningProfile_IsResource(construct constructs.IConstruct) *bool
Check whether the given construct is a Resource.
func SigningProfile_PROPERTY_INJECTION_ID ¶ added in v2.196.0
func SigningProfile_PROPERTY_INJECTION_ID() *string
Types ¶
type CfnProfilePermission ¶
type CfnProfilePermission interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawssigner.IProfilePermissionRef
// The AWS Signer action permitted as part of cross-account permissions.
Action() *string
SetAction(val *string)
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The AWS principal receiving cross-account permissions.
Principal() *string
SetPrincipal(val *string)
// The human-readable name of the signing profile.
ProfileName() *string
SetProfileName(val *string)
// A reference to a ProfilePermission resource.
ProfilePermissionRef() *interfacesawssigner.ProfilePermissionReference
// The version of the signing profile.
ProfileVersion() *string
SetProfileVersion(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// A unique identifier for the cross-account permission statement.
StatementId() *string
SetStatementId(val *string)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveResourceDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Adds cross-account permissions to a signing profile.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnProfilePermission := awscdk.Aws_signer.NewCfnProfilePermission(this, jsii.String("MyCfnProfilePermission"), &CfnProfilePermissionProps{
Action: jsii.String("action"),
Principal: jsii.String("principal"),
ProfileName: jsii.String("profileName"),
StatementId: jsii.String("statementId"),
// the properties below are optional
ProfileVersion: jsii.String("profileVersion"),
})
func NewCfnProfilePermission ¶
func NewCfnProfilePermission(scope constructs.Construct, id *string, props *CfnProfilePermissionProps) CfnProfilePermission
Create a new `AWS::Signer::ProfilePermission`.
type CfnProfilePermissionProps ¶
type CfnProfilePermissionProps struct {
// The AWS Signer action permitted as part of cross-account permissions.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html#cfn-signer-profilepermission-action
//
Action *string `field:"required" json:"action" yaml:"action"`
// The AWS principal receiving cross-account permissions.
//
// This may be an IAM role or another AWS account ID.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html#cfn-signer-profilepermission-principal
//
Principal *string `field:"required" json:"principal" yaml:"principal"`
// The human-readable name of the signing profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html#cfn-signer-profilepermission-profilename
//
ProfileName *string `field:"required" json:"profileName" yaml:"profileName"`
// A unique identifier for the cross-account permission statement.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html#cfn-signer-profilepermission-statementid
//
StatementId *string `field:"required" json:"statementId" yaml:"statementId"`
// The version of the signing profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-profilepermission.html#cfn-signer-profilepermission-profileversion
//
ProfileVersion *string `field:"optional" json:"profileVersion" yaml:"profileVersion"`
}
Properties for defining a `CfnProfilePermission`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnProfilePermissionProps := &CfnProfilePermissionProps{
Action: jsii.String("action"),
Principal: jsii.String("principal"),
ProfileName: jsii.String("profileName"),
StatementId: jsii.String("statementId"),
// the properties below are optional
ProfileVersion: jsii.String("profileVersion"),
}
type CfnSigningJob ¶ added in v2.264.0
type CfnSigningJob interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawssigner.ISigningJobRef
// The ARN of the signing job.
AttrArn() *string
// Date and time that the signing job was completed.
AttrCompletedAt() *string
// Date and time that the signing job was created.
AttrCreatedAt() *string
// The ID of the signing job.
AttrJobId() *string
// The IAM entity that initiated the signing job.
AttrJobInvoker() *string
// The AWS account ID of the job owner.
AttrJobOwner() *string
// A human-readable name for the signing platform associated with the signing job.
AttrPlatformDisplayName() *string
// The microcontroller platform to which the signed code image will be distributed.
AttrPlatformId() *string
// The version of the signing profile used to initiate the signing job.
AttrProfileVersion() *string
// The IAM principal that requested the signing job.
AttrRequestedBy() *string
// The expiration timestamp for the signature generated by the signing job.
AttrSignatureExpiresAt() *string
// The S3 location of the signed code image.
AttrSignedObject() awscdk.IResolvable
// Information about the S3 bucket where unsigned code is stored.
AttrSource() awscdk.IResolvable
// Status of the signing job.
AttrStatus() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The name of the signing profile.
ProfileName() *string
SetProfileName(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// A reference to a SigningJob resource.
SigningJobRef() *interfacesawssigner.SigningJobReference
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveResourceDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Represents an AWS Signer signing job.
Signing jobs are initiated via StartSigningJob and are read-only resources that provide visibility into code signing operations.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnSigningJob := awscdk.Aws_signer.NewCfnSigningJob(this, jsii.String("MyCfnSigningJob"), &CfnSigningJobProps{
ProfileName: jsii.String("profileName"),
})
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingjob.html
func NewCfnSigningJob ¶ added in v2.264.0
func NewCfnSigningJob(scope constructs.Construct, id *string, props *CfnSigningJobProps) CfnSigningJob
Create a new `AWS::Signer::SigningJob`.
type CfnSigningJobProps ¶ added in v2.264.0
type CfnSigningJobProps struct {
// The name of the signing profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingjob.html#cfn-signer-signingjob-profilename
//
ProfileName *string `field:"required" json:"profileName" yaml:"profileName"`
}
Properties for defining a `CfnSigningJob`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnSigningJobProps := &CfnSigningJobProps{
ProfileName: jsii.String("profileName"),
}
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingjob.html
type CfnSigningJob_S3SignedObjectProperty ¶ added in v2.264.0
type CfnSigningJob_S3SignedObjectProperty struct {
// Name of the S3 bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingjob-s3signedobject.html#cfn-signer-signingjob-s3signedobject-bucketname
//
BucketName *string `field:"optional" json:"bucketName" yaml:"bucketName"`
// Key name that uniquely identifies a signed code image in the bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingjob-s3signedobject.html#cfn-signer-signingjob-s3signedobject-key
//
Key *string `field:"optional" json:"key" yaml:"key"`
}
The Amazon S3 bucket name and key where Signer saved the signed code image.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
s3SignedObjectProperty := &S3SignedObjectProperty{
BucketName: jsii.String("bucketName"),
Key: jsii.String("key"),
}
type CfnSigningJob_S3SourceProperty ¶ added in v2.264.0
type CfnSigningJob_S3SourceProperty struct {
// Name of the S3 bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingjob-s3source.html#cfn-signer-signingjob-s3source-bucketname
//
BucketName *string `field:"required" json:"bucketName" yaml:"bucketName"`
// Key name of the bucket object that contains unsigned code.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingjob-s3source.html#cfn-signer-signingjob-s3source-key
//
Key *string `field:"required" json:"key" yaml:"key"`
// Version of the source image in the version-enabled S3 bucket.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingjob-s3source.html#cfn-signer-signingjob-s3source-version
//
Version *string `field:"required" json:"version" yaml:"version"`
}
Information about the Amazon S3 bucket where unsigned code is stored.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
s3SourceProperty := &S3SourceProperty{
BucketName: jsii.String("bucketName"),
Key: jsii.String("key"),
Version: jsii.String("version"),
}
type CfnSigningJob_SignedObjectProperty ¶ added in v2.264.0
type CfnSigningJob_SignedObjectProperty struct {
// The Amazon S3 bucket name and key where Signer saved the signed code image.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingjob-signedobject.html#cfn-signer-signingjob-signedobject-s3
//
S3 interface{} `field:"optional" json:"s3" yaml:"s3"`
}
The S3 location of the signed code image.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
signedObjectProperty := &SignedObjectProperty{
S3: &S3SignedObjectProperty{
BucketName: jsii.String("bucketName"),
Key: jsii.String("key"),
},
}
type CfnSigningJob_SourceProperty ¶ added in v2.264.0
type CfnSigningJob_SourceProperty struct {
// Information about the Amazon S3 bucket where unsigned code is stored.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingjob-source.html#cfn-signer-signingjob-source-s3
//
S3 interface{} `field:"optional" json:"s3" yaml:"s3"`
}
Information about the S3 bucket where unsigned code is stored.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
sourceProperty := &SourceProperty{
S3: &S3SourceProperty{
BucketName: jsii.String("bucketName"),
Key: jsii.String("key"),
Version: jsii.String("version"),
},
}
type CfnSigningProfile ¶
type CfnSigningProfile interface {
awscdk.CfnResource
awscdk.IInspectable
interfacesawssigner.ISigningProfileRef
awscdk.ITaggable
// The Amazon Resource Name (ARN) of the signing profile created.
AttrArn() *string
// The name of the signing profile created.
AttrProfileName() *string
// The version of the signing profile created.
AttrProfileVersion() *string
// The signing profile ARN, including the profile version.
AttrProfileVersionArn() *string
// Options for this resource, such as condition, update policy etc.
CfnOptions() awscdk.ICfnResourceOptions
CfnProperties() *map[string]interface{}
CfnPropertyNames() *map[string]*string
// AWS resource type.
CfnResourceType() *string
// Returns: the stack trace of the point where this Resource was created from, sourced
// from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most
// node +internal+ entries filtered.
CreationStack() *[]*string
Env() *interfaces.ResourceEnvironment
// The logical ID for this CloudFormation stack element.
//
// The logical ID of the element
// is calculated from the path of the resource node in the construct tree.
//
// To override this value, use `overrideLogicalId(newLogicalId)`.
//
// Returns: the logical ID as a stringified token. This value will only get
// resolved during synthesis.
LogicalId() *string
// The tree node.
Node() constructs.Node
// The ID of a platform that is available for use by a signing profile.
PlatformId() *string
SetPlatformId(val *string)
// The name of the signing profile.
ProfileName() *string
SetProfileName(val *string)
// Return a string that will be resolved to a CloudFormation `{ Ref }` for this element.
//
// If, by any chance, the intrinsic reference of a resource is not a string, you could
// coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`.
Ref() *string
// The validity period override for any signature generated using this signing profile.
SignatureValidityPeriod() interface{}
SetSignatureValidityPeriod(val interface{})
// A reference to a SigningProfile resource.
SigningProfileRef() *interfacesawssigner.SigningProfileReference
// The stack in which this element is defined.
//
// CfnElements must be defined within a stack scope (directly or indirectly).
Stack() awscdk.Stack
// Tag Manager which manages the tags for this resource.
Tags() awscdk.TagManager
// A list of tags associated with the signing profile.
TagsRaw() *[]*awscdk.CfnTag
SetTagsRaw(val *[]*awscdk.CfnTag)
// Deprecated.
// Deprecated: use `updatedProperties`
//
// Return properties modified after initiation
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperites() *map[string]interface{}
// Return properties modified after initiation.
//
// Resources that expose mutable properties should override this function to
// collect and return the properties object for this resource.
UpdatedProperties() *map[string]interface{}
// Syntactic sugar for `addOverride(path, undefined)`.
AddDeletionOverride(path *string)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency` to more clearly
// set it apart from `construct.node.addDependency`. See the documentation
// of that function for more details.
// Deprecated: Use `addResourceDependency` instead.
AddDependency(target awscdk.CfnResource)
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This method has been renamed to `addResourceDependency`, which makes it
// more clear that this method operates at a different level from the
// construct-level `construct.node.addDependency()` mechanism.
// Deprecated: Use `addResourceDependency` instead.
AddDependsOn(target awscdk.CfnResource)
// Add a value to the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
AddMetadata(key *string, value interface{})
// Adds an override to the synthesized CloudFormation resource.
//
// To add a
// property override, either use `addPropertyOverride` or prefix `path` with
// "Properties." (i.e. `Properties.TopicName`).
//
// If the override is nested, separate each nested level using a dot (.) in the path parameter.
// If there is an array as part of the nesting, specify the index in the path.
//
// To include a literal `.` in the property name, prefix with a `\`. In most
// programming languages you will need to write this as `"\\."` because the
// `\` itself will need to be escaped.
//
// For example,
// “`typescript
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
// cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
// “`
// would add the overrides
// “`json
// "Properties": {
// "GlobalSecondaryIndexes": [
// {
// "Projection": {
// "NonKeyAttributes": [ "myattribute" ]
// ...
// }
// ...
// },
// {
// "ProjectionType": "INCLUDE"
// ...
// },
// ]
// ...
// }
// “`
//
// The `value` argument to `addOverride` will not be processed or translated
// in any way. Pass raw JSON values in here with the correct capitalization
// for CloudFormation. If you pass CDK classes or structs, they will be
// rendered with lowercased key names, and CloudFormation will reject the
// template.
AddOverride(path *string, value interface{})
// Adds an override that deletes the value of a property from the resource definition.
AddPropertyDeletionOverride(propertyPath *string)
// Adds an override to a resource property.
//
// Syntactic sugar for `addOverride("Properties.<...>", value)`.
AddPropertyOverride(propertyPath *string, value interface{})
// Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
//
// This can be used for resources across stacks (or nested stack) boundaries
// and the dependency will automatically be transferred to the relevant scope.
//
// This method only adds dependencies between L1 resources. If you are
// looking for a generic construct-to-construct dependency mechanism that works
// for all constructs including L2s, use `construct.node.addDependency` instead.
AddResourceDependency(target awscdk.CfnResource, reason *string)
// Sets the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// strength instead of the global default from the consuming stack's context.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// Sets the deletion policy of the resource based on the removal policy specified.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some
// cases, a snapshot can be taken of the resource prior to deletion
// (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy
// can be found in the following link:.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options
//
ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
CfnPropertyName(cdkPropertyName *string) *string
// Returns a token for an runtime attribute of this resource.
//
// Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility
// in case there is no generated attribute.
GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference
// Retrieve a value value from the CloudFormation Resource Metadata.
// See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
//
// Note that this is a different set of metadata from CDK node metadata; this
// metadata ends up in the stack template under the resource, whereas CDK
// node metadata ends up in the Cloud Assembly.
//
GetMetadata(key *string) interface{}
// Examines the CloudFormation resource and discloses attributes.
Inspect(inspector awscdk.TreeInspector)
// Retrieves an array of resources this resource depends on.
//
// This assembles dependencies on resources across stacks (including nested stacks)
// automatically.
ObtainDependencies() *[]interface{}
// Overrides the auto-generated logical ID with a specific ID.
OverrideLogicalId(newLogicalId *string)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
// Deprecated: Use `removeResourceDependency` instead.
RemoveDependency(target awscdk.CfnResource)
// Indicates that this resource no longer depends on another resource.
//
// This can be used for resources across stacks (including nested stacks)
// and the dependency will automatically be removed from the relevant scope.
RemoveResourceDependency(target awscdk.CfnResource)
RenderProperties(props *map[string]interface{}) *map[string]interface{}
// Replaces one dependency with another.
ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource)
// Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.
//
// Returns: `true` if the resource should be included or `false` is the resource
// should be omitted.
ShouldSynthesize() *bool
// Returns a string representation of this construct.
//
// Returns: a string representation of this resource.
ToString() *string
ValidateProperties(_properties interface{})
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Creates a signing profile.
A signing profile is a code-signing template that can be used to carry out a pre-defined signing job.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnSigningProfile := awscdk.Aws_signer.NewCfnSigningProfile(this, jsii.String("MyCfnSigningProfile"), &CfnSigningProfileProps{
PlatformId: jsii.String("platformId"),
// the properties below are optional
ProfileName: jsii.String("profileName"),
SignatureValidityPeriod: &SignatureValidityPeriodProperty{
Type: jsii.String("type"),
Value: jsii.Number(123),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
})
func NewCfnSigningProfile ¶
func NewCfnSigningProfile(scope constructs.Construct, id *string, props *CfnSigningProfileProps) CfnSigningProfile
Create a new `AWS::Signer::SigningProfile`.
type CfnSigningProfileProps ¶
type CfnSigningProfileProps struct {
// The ID of a platform that is available for use by a signing profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#cfn-signer-signingprofile-platformid
//
PlatformId *string `field:"required" json:"platformId" yaml:"platformId"`
// The name of the signing profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#cfn-signer-signingprofile-profilename
//
ProfileName *string `field:"optional" json:"profileName" yaml:"profileName"`
// The validity period override for any signature generated using this signing profile.
//
// If unspecified, the default is 135 months.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#cfn-signer-signingprofile-signaturevalidityperiod
//
SignatureValidityPeriod interface{} `field:"optional" json:"signatureValidityPeriod" yaml:"signatureValidityPeriod"`
// A list of tags associated with the signing profile.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#cfn-signer-signingprofile-tags
//
Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"`
}
Properties for defining a `CfnSigningProfile`.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
cfnSigningProfileProps := &CfnSigningProfileProps{
PlatformId: jsii.String("platformId"),
// the properties below are optional
ProfileName: jsii.String("profileName"),
SignatureValidityPeriod: &SignatureValidityPeriodProperty{
Type: jsii.String("type"),
Value: jsii.Number(123),
},
Tags: []CfnTag{
&CfnTag{
Key: jsii.String("key"),
Value: jsii.String("value"),
},
},
}
type CfnSigningProfile_SignatureValidityPeriodProperty ¶
type CfnSigningProfile_SignatureValidityPeriodProperty struct {
// The time unit for signature validity: DAYS | MONTHS | YEARS.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingprofile-signaturevalidityperiod.html#cfn-signer-signingprofile-signaturevalidityperiod-type
//
Type *string `field:"optional" json:"type" yaml:"type"`
// The numerical value of the time unit for signature validity.
// See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-signer-signingprofile-signaturevalidityperiod.html#cfn-signer-signingprofile-signaturevalidityperiod-value
//
Value *float64 `field:"optional" json:"value" yaml:"value"`
}
The validity period for the signing job.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
signatureValidityPeriodProperty := &SignatureValidityPeriodProperty{
Type: jsii.String("type"),
Value: jsii.Number(123),
}
type ISigningProfile ¶
type ISigningProfile interface {
awscdk.IResource
interfacesawssigner.ISigningProfileRef
// The ARN of the signing profile.
SigningProfileArn() *string
// The name of signing profile.
SigningProfileName() *string
// The version of signing profile.
SigningProfileVersion() *string
// The ARN of signing profile version.
SigningProfileVersionArn() *string
}
A Signer Profile.
func SigningProfile_FromSigningProfileAttributes ¶
func SigningProfile_FromSigningProfileAttributes(scope constructs.Construct, id *string, attrs *SigningProfileAttributes) ISigningProfile
Creates a Signing Profile construct that represents an external Signing Profile.
type Platform ¶
type Platform interface {
// - The id of signing platform.
PlatformId() *string
}
Platforms that are allowed with signing config.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
signingProfile := signer.NewSigningProfile(this, jsii.String("SigningProfile"), &SigningProfileProps{
Platform: signer.Platform_AWS_LAMBDA_SHA384_ECDSA(),
})
codeSigningConfig := lambda.NewCodeSigningConfig(this, jsii.String("CodeSigningConfig"), &CodeSigningConfigProps{
SigningProfiles: []ISigningProfile{
signingProfile,
},
})
lambda.NewFunction(this, jsii.String("Function"), &FunctionProps{
CodeSigningConfig: CodeSigningConfig,
Runtime: lambda.Runtime_NODEJS_LATEST(),
Handler: jsii.String("index.handler"),
Code: lambda.Code_FromAsset(path.join(__dirname, jsii.String("lambda-handler"))),
})
See: https://docs.aws.amazon.com/signer/latest/developerguide/gs-platform.html
func Platform_AMAZON_FREE_RTOS_DEFAULT ¶
func Platform_AMAZON_FREE_RTOS_DEFAULT() Platform
func Platform_AMAZON_FREE_RTOS_TI_CC3220SF ¶
func Platform_AMAZON_FREE_RTOS_TI_CC3220SF() Platform
func Platform_AWS_IOT_DEVICE_MANAGEMENT_SHA256_ECDSA ¶
func Platform_AWS_IOT_DEVICE_MANAGEMENT_SHA256_ECDSA() Platform
func Platform_AWS_LAMBDA_SHA384_ECDSA ¶
func Platform_AWS_LAMBDA_SHA384_ECDSA() Platform
func Platform_NOTATION_OCI_SHA384_ECDSA ¶ added in v2.119.0
func Platform_NOTATION_OCI_SHA384_ECDSA() Platform
func Platform_Of ¶ added in v2.119.0
Custom signing profile platform. See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-signer-signingprofile.html#cfn-signer-signingprofile-platformid
type SigningProfile ¶
type SigningProfile interface {
awscdk.Resource
ISigningProfile
// The environment this resource belongs to.
//
// For resources that are created and managed in a Stack (those created by
// creating new class instances like `new Role()`, `new Bucket()`, etc.), this
// is always the same as the environment of the stack they belong to.
//
// For referenced resources (those obtained from referencing methods like
// `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
// different than the stack they were imported into.
Env() *interfaces.ResourceEnvironment
// The tree node.
Node() constructs.Node
// Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.
//
// This value will resolve to one of the following:
// - a concrete value (e.g. `"my-awesome-bucket"`)
// - `undefined`, when a name should be generated by CloudFormation
// - a concrete name generated automatically during synthesis, in
// cross-environment scenarios.
PhysicalName() *string
// The ARN of the signing profile.
SigningProfileArn() *string
// The name of signing profile.
SigningProfileName() *string
// A reference to a SigningProfile resource.
SigningProfileRef() *interfacesawssigner.SigningProfileReference
// The version of signing profile.
SigningProfileVersion() *string
// The ARN of signing profile version.
SigningProfileVersionArn() *string
// The stack in which this resource is defined.
Stack() awscdk.Stack
// Override the cross-stack reference strength for this resource.
//
// When set, any cross-stack reference to this resource will use the specified
// mechanism instead of the global default determined by the
// `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
// selectively weakening specific references to avoid the "deadly embrace" problem
// without changing the app-wide default.
ApplyCrossStackReferenceStrength(strength awscdk.ReferenceStrength)
// Apply the given removal policy to this resource.
//
// The Removal Policy controls what happens to this resource when it stops
// being managed by CloudFormation, either because you've removed it from the
// CDK application or because you've made a change that requires the resource
// to be replaced.
//
// The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
// account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).
ApplyRemovalPolicy(policy awscdk.RemovalPolicy)
GeneratePhysicalName() *string
// Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. `bucket.bucketArn`).
//
// Normally, this token will resolve to `arnAttr`, but if the resource is
// referenced across environments, `arnComponents` will be used to synthesize
// a concrete ARN with the resource's physical name. Make sure to reference
// `this.physicalName` in `arnComponents`.
GetResourceArnAttribute(arnAttr *string, arnComponents *awscdk.ArnComponents) *string
// Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. `bucket.bucketName`).
//
// Normally, this token will resolve to `nameAttr`, but if the resource is
// referenced across environments, it will be resolved to `this.physicalName`,
// which will be a concrete name.
GetResourceNameAttribute(nameAttr *string) *string
// Returns a string representation of this construct.
ToString() *string
// Applies one or more mixins to this construct.
//
// Mixins are applied in order. The list of constructs is captured at the
// start of the call, so constructs added by a mixin will not be visited.
// Use multiple `with()` calls if subsequent mixins should apply to added
// constructs.
With(mixins ...constructs.IMixin) constructs.IConstruct
}
Defines a Signing Profile.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
signingProfile := signer.NewSigningProfile(this, jsii.String("SigningProfile"), &SigningProfileProps{
Platform: signer.Platform_AWS_LAMBDA_SHA384_ECDSA(),
})
codeSigningConfig := lambda.NewCodeSigningConfig(this, jsii.String("CodeSigningConfig"), &CodeSigningConfigProps{
SigningProfiles: []ISigningProfile{
signingProfile,
},
})
lambda.NewFunction(this, jsii.String("Function"), &FunctionProps{
CodeSigningConfig: CodeSigningConfig,
Runtime: lambda.Runtime_NODEJS_LATEST(),
Handler: jsii.String("index.handler"),
Code: lambda.Code_FromAsset(path.join(__dirname, jsii.String("lambda-handler"))),
})
func NewSigningProfile ¶
func NewSigningProfile(scope constructs.Construct, id *string, props *SigningProfileProps) SigningProfile
type SigningProfileAttributes ¶
type SigningProfileAttributes struct {
// The name of signing profile.
SigningProfileName *string `field:"required" json:"signingProfileName" yaml:"signingProfileName"`
// The version of signing profile.
SigningProfileVersion *string `field:"required" json:"signingProfileVersion" yaml:"signingProfileVersion"`
}
A reference to a Signing Profile.
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"
signingProfileAttributes := &SigningProfileAttributes{
SigningProfileName: jsii.String("signingProfileName"),
SigningProfileVersion: jsii.String("signingProfileVersion"),
}
type SigningProfileProps ¶
type SigningProfileProps struct {
// The Signing Platform available for signing profile.
// See: https://docs.aws.amazon.com/signer/latest/developerguide/gs-platform.html
//
Platform Platform `field:"required" json:"platform" yaml:"platform"`
// The validity period for signatures generated using this signing profile.
// Default: - 135 months.
//
SignatureValidity awscdk.Duration `field:"optional" json:"signatureValidity" yaml:"signatureValidity"`
// Physical name of this Signing Profile.
// Default: - Assigned by CloudFormation (recommended).
//
SigningProfileName *string `field:"optional" json:"signingProfileName" yaml:"signingProfileName"`
}
Construction properties for a Signing Profile object.
Example:
import "github.com/aws/aws-cdk-go/awscdk"
signingProfile := signer.NewSigningProfile(this, jsii.String("SigningProfile"), &SigningProfileProps{
Platform: signer.Platform_AWS_LAMBDA_SHA384_ECDSA(),
})
codeSigningConfig := lambda.NewCodeSigningConfig(this, jsii.String("CodeSigningConfig"), &CodeSigningConfigProps{
SigningProfiles: []ISigningProfile{
signingProfile,
},
})
lambda.NewFunction(this, jsii.String("Function"), &FunctionProps{
CodeSigningConfig: CodeSigningConfig,
Runtime: lambda.Runtime_NODEJS_LATEST(),
Handler: jsii.String("index.handler"),
Code: lambda.Code_FromAsset(path.join(__dirname, jsii.String("lambda-handler"))),
})
Source Files
¶
- CfnProfilePermission.go
- CfnProfilePermissionProps.go
- CfnProfilePermission__checks.go
- CfnSigningJob.go
- CfnSigningJobProps.go
- CfnSigningJob_S3SignedObjectProperty.go
- CfnSigningJob_S3SourceProperty.go
- CfnSigningJob_SignedObjectProperty.go
- CfnSigningJob_SourceProperty.go
- CfnSigningJob__checks.go
- CfnSigningProfile.go
- CfnSigningProfileProps.go
- CfnSigningProfile_SignatureValidityPeriodProperty.go
- CfnSigningProfile__checks.go
- ISigningProfile.go
- ISigningProfile__checks.go
- Platform.go
- Platform__checks.go
- SigningProfile.go
- SigningProfileAttributes.go
- SigningProfileProps.go
- SigningProfile__checks.go
- main.go