Skip to content

Commit 20890ae

Browse files
Fixed some comments for keys and endpoints
1 parent a1d807e commit 20890ae

2 files changed

Lines changed: 18 additions & 8 deletions

File tree

src/ImageSharp.Web.Providers.AWS/Caching/AWSS3StorageCacheOptions.cs

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ namespace SixLabors.ImageSharp.Web.Caching.AWS
99
public class AWSS3StorageCacheOptions
1010
{
1111
/// <summary>
12-
/// Gets or sets the AWS region name.
12+
/// Gets or sets the AWS region endpoint (us-east-1/us-west-1/ap-southeast-2).
1313
/// </summary>
1414
public string Region { get; set; }
1515

@@ -19,17 +19,22 @@ public class AWSS3StorageCacheOptions
1919
public string BucketName { get; set; }
2020

2121
/// <summary>
22-
/// Gets or sets the AWS key - optional.
22+
/// Gets or sets the AWS key - Can be used to override keys provided by the environment.
23+
/// If deploying inside an EC2 instance AWS keys will already be available via environment
24+
/// variables and don't need to be specified. Follow AWS best security practices on <see href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html"/>.
2325
/// </summary>
2426
public string AccessKey { get; set; }
2527

2628
/// <summary>
27-
/// Gets or sets the AWS secret - optional.
29+
/// Gets or sets the AWS secret - Can be used to override keys provided by the environment.
30+
/// If deploying inside an EC2 instance AWS keys will already be available via environment
31+
/// variables and don't need to be specified. Follow AWS best security practices on <see href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html"/>.
2832
/// </summary>
2933
public string AccessSecret { get; set; }
3034

3135
/// <summary>
32-
/// Gets or sets the AWS endpoint - override for testing
36+
/// Gets or sets the AWS endpoint - used for testing to over region endpoint allowing it
37+
/// to be set to localhost.
3338
/// </summary>
3439
public string Endpoint { get; set; }
3540
}

src/ImageSharp.Web.Providers.AWS/Providers/AWSS3StorageImageProviderOptions.cs

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public class AWSS3StorageImageProviderOptions
2222
public class AWSS3BucketClientOptions
2323
{
2424
/// <summary>
25-
/// Gets or sets the AWS region name.
25+
/// Gets or sets the AWS region endpoint (us-east-1/us-west-1/ap-southeast-2).
2626
/// </summary>
2727
public string Region { get; set; }
2828

@@ -32,17 +32,22 @@ public class AWSS3BucketClientOptions
3232
public string BucketName { get; set; }
3333

3434
/// <summary>
35-
/// Gets or sets the AWS key - optional.
35+
/// Gets or sets the AWS key - Can be used to override keys provided by the environment.
36+
/// If deploying inside an EC2 instance AWS keys will already be available via environment
37+
/// variables and don't need to be specified. Follow AWS best security practices on <see href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html"/>.
3638
/// </summary>
3739
public string AccessKey { get; set; }
3840

3941
/// <summary>
40-
/// Gets or sets the AWS secret - optional.
42+
/// Gets or sets the AWS secret - Can be used to override keys provided by the environment.
43+
/// If deploying inside an EC2 instance AWS keys will already be available via environment
44+
/// variables and don't need to be specified. Follow AWS best security practices on <see href="https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html"/>.
4145
/// </summary>
4246
public string AccessSecret { get; set; }
4347

4448
/// <summary>
45-
/// Gets or sets the AWS endpoint - override for testing
49+
/// Gets or sets the AWS endpoint - used for testing to over region endpoint allowing it
50+
/// to be set to localhost.
4651
/// </summary>
4752
public string Endpoint { get; set; }
4853
}

0 commit comments

Comments
 (0)